Updated API docs

ec799b54 · Matija Obreza · a198e79d · ec799b54 · ec799b54 · ec799b54
Commit ec799b54 authored Sep 22, 2017 by Matija Obreza
10 changed files
--- a/docs/Acquisition.md
+++ b/docs/Acquisition.md
+
+# Acquisition
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**provider** | [**Actor**](Actor.md) |  | 
+**sampleid** | **String** |  |  [optional]
+**provenance** | **String** | ISO-3166 alpha-3 country code (https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3) of the country of provenance. |  [optional]
+
+
+
--- a/docs/BasePGRFA.md
+++ b/docs/BasePGRFA.md
@@ -6,19 +6,27 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **username** | **String** |  |  [optional]
 **password** | **String** |  |  [optional]
-**sampledoi** | [**UUID**](UUID.md) | A Digital Object Identifier (DOI) obtained from a service other than GLIS and that is already assigned to the PGRFA. |  [optional]
-**sampleid** | **String** |  |  [optional]
 **location** | [**Location**](Location.md) |  |  [optional]
+**sampledoi** | **String** | A Digital Object Identifier (DOI) obtained from a service other than GLIS and that is already assigned to the PGRFA. |  [optional]
+**sampleid** | **String** | A string that identifies the PGRFA that is being registered. This value will be returned by GLIS in the response message and is assumed to be used to associate the DOI to the corresponding material in the local database. You must provide &lt;sampleid&gt; even if &lt;sampledoi&gt; is provided. In case you use the DOI as unique identifier in your local database, you can repeat it in &lt;sampleid&gt;. Mandatory. Please read more details in the “HTTPS reply” chapter. |  [optional]
 **date** | **String** | Date in which PGRFA became part of the collection. Date fragments (YYYY-MM and YYYY) are also accepted. |  [optional]
-**genus** | **String** |  |  [optional]
-**cropname** | **String** |  |  [optional]
-**species** | **String** |  |  [optional]
-**spauth** | **String** |  |  [optional]
-**subtaxa** | **String** |  |  [optional]
-**stauth** | **String** |  |  [optional]
-**method** | **String** |  |  [optional]
-**biostatus** | **Integer** |  |  [optional]
-**mlsstatus** | **Integer** |  |  [optional]
+**method** | **String** | Method through which the PGRFA has been acquired. Mandatory. |  [optional]
+**genus** | **String** | The taxon of the genus for the PGRFA. At least one between &lt;genus&gt; and &lt;cropname&gt; must be provided. |  [optional]
+**cropnames** | **List&lt;String&gt;** | Common name of the crop. At least one between &lt;genus&gt; and one cropname must be provided. Multiple names are allowed. |  [optional]
+**targets** | [**List&lt;Target&gt;**](Target.md) |  |  [optional]
+**progdoi** | **List&lt;String&gt;** | DOI of the progenitor PGRFA as registered in GLIS. Please note that the number of allowed DOIs depends on the method as follows   * Acquisition - 1 DOI  * In-house copy - 1 DOI  * In-house variant - 1 DOI  * Novel distinct PGRFA - 1 or more DOIs  * Observation - Natural - 0 DOI  * Observation – Inherited - 0 DOI |  [optional]
+**biostatus** | **Integer** | Biological status of the PGRFA. |  [optional]
+**species** | **String** | Specific epithet of the PGRFA scientific name. If not provided, \&quot;sp.\&quot; is assumed. |  [optional]
+**spauth** | **String** | Authority for the specific epithet. |  [optional]
+**subtaxa** | **String** | Any additional infra-specific taxon such as subspecies, variety, form, Group and so on. |  [optional]
+**stauth** | **String** | Authority for the subtaxon at the most detailed level provided. |  [optional]
+**names** | **List&lt;String&gt;** | Other name of the PGRFA. Any number of names can be provided. |  [optional]
+**ids** | **List&lt;String&gt;** |  |  [optional]
+**mlsstatus** | **Integer** | Code that identifies the status of the PGRFA with regard to the MLS. |  [optional]
+**historical** | **String** | Indicates whether the PGRFA currently exists. Allowed value is y/n |  [optional]
+**acquisition** | [**Acquisition**](Acquisition.md) |  |  [optional]
+**collection** | [**Collection**](Collection.md) |  |  [optional]
+**breeding** | [**Breeding**](Breeding.md) |  |  [optional]



--- a/docs/Breeder.md
+++ b/docs/Breeder.md
+
+# Breeder
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wiews** | **String** | FAO/WIEWS Institute code |  [optional]
+**pid** | **String** | Easy-SMTA PID |  [optional]
+**name** | **String** | Name |  [optional]
+**address** | **String** | Address |  [optional]
+**country** | **String** | ISO-3166 apha-3 country code |  [optional]
+
+
+
--- a/docs/Breeding.md
+++ b/docs/Breeding.md
+
+# Breeding
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**breeders** | [**List&lt;Breeder&gt;**](Breeder.md) |  |  [optional]
+**ancestry** | **String** | Pedigree or other description of the ancestry of the PGRFA and how it was bred. |  [optional]
+
+
+
--- a/docs/Collection.md
+++ b/docs/Collection.md
+
+# Collection
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**collectors** | [**List&lt;Collector&gt;**](Collector.md) |  |  [optional]
+**sampleid** | **String** |  |  [optional]
+**missid** | **String** |  |  [optional]
+**site** | **String** |  |  [optional]
+**lat** | **String** |  |  [optional]
+**lon** | **String** |  |  [optional]
+**uncert** | **String** |  |  [optional]
+**datum** | **String** |  |  [optional]
+**georef** | **String** |  |  [optional]
+**elevation** | **Integer** | Elevation of collecting site in metres above sea level. |  [optional]
+**date** | **String** | Date on which the PGRFA was collected. Date fragments (YYYY-MM and YYYY) are also accepted. |  [optional]
+**source** | **String** | Code of the nature of the location where the PGRFA was collected. |  [optional]
+
+
+
--- a/docs/Collector.md
+++ b/docs/Collector.md
+
+# Collector
+
+## Properties
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**wiews** | **String** | FAO/WIEWS Institute code |  [optional]
+**pid** | **String** | Easy-SMTA PID |  [optional]
+**name** | **String** | Name |  [optional]
+**address** | **String** | Address |  [optional]
+**country** | **String** | ISO-3166 apha-3 country code |  [optional]
+
+
+
--- a/docs/GLISUpdate.md
+++ b/docs/GLISUpdate.md
@@ -6,19 +6,27 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **username** | **String** |  |  [optional]
 **password** | **String** |  |  [optional]
-**sampledoi** | [**UUID**](UUID.md) | A Digital Object Identifier (DOI) obtained from a service other than GLIS and that is already assigned to the PGRFA. |  [optional]
-**sampleid** | **String** |  |  [optional]
 **location** | [**Location**](Location.md) |  |  [optional]
+**sampledoi** | **String** | A Digital Object Identifier (DOI) obtained from a service other than GLIS and that is already assigned to the PGRFA. |  [optional]
+**sampleid** | **String** | A string that identifies the PGRFA that is being registered. This value will be returned by GLIS in the response message and is assumed to be used to associate the DOI to the corresponding material in the local database. You must provide &lt;sampleid&gt; even if &lt;sampledoi&gt; is provided. In case you use the DOI as unique identifier in your local database, you can repeat it in &lt;sampleid&gt;. Mandatory. Please read more details in the “HTTPS reply” chapter. |  [optional]
 **date** | **String** | Date in which PGRFA became part of the collection. Date fragments (YYYY-MM and YYYY) are also accepted. |  [optional]
-**genus** | **String** |  |  [optional]
-**cropname** | **String** |  |  [optional]
-**species** | **String** |  |  [optional]
-**spauth** | **String** |  |  [optional]
-**subtaxa** | **String** |  |  [optional]
-**stauth** | **String** |  |  [optional]
-**method** | **String** |  |  [optional]
-**biostatus** | **Integer** |  |  [optional]
-**mlsstatus** | **Integer** |  |  [optional]
+**method** | **String** | Method through which the PGRFA has been acquired. Mandatory. |  [optional]
+**genus** | **String** | The taxon of the genus for the PGRFA. At least one between &lt;genus&gt; and &lt;cropname&gt; must be provided. |  [optional]
+**cropnames** | **List&lt;String&gt;** | Common name of the crop. At least one between &lt;genus&gt; and one cropname must be provided. Multiple names are allowed. |  [optional]
+**targets** | [**List&lt;Target&gt;**](Target.md) |  |  [optional]
+**progdoi** | **List&lt;String&gt;** | DOI of the progenitor PGRFA as registered in GLIS. Please note that the number of allowed DOIs depends on the method as follows   * Acquisition - 1 DOI  * In-house copy - 1 DOI  * In-house variant - 1 DOI  * Novel distinct PGRFA - 1 or more DOIs  * Observation - Natural - 0 DOI  * Observation – Inherited - 0 DOI |  [optional]
+**biostatus** | **Integer** | Biological status of the PGRFA. |  [optional]
+**species** | **String** | Specific epithet of the PGRFA scientific name. If not provided, \&quot;sp.\&quot; is assumed. |  [optional]
+**spauth** | **String** | Authority for the specific epithet. |  [optional]
+**subtaxa** | **String** | Any additional infra-specific taxon such as subspecies, variety, form, Group and so on. |  [optional]
+**stauth** | **String** | Authority for the subtaxon at the most detailed level provided. |  [optional]
+**names** | **List&lt;String&gt;** | Other name of the PGRFA. Any number of names can be provided. |  [optional]
+**ids** | **List&lt;String&gt;** |  |  [optional]
+**mlsstatus** | **Integer** | Code that identifies the status of the PGRFA with regard to the MLS. |  [optional]
+**historical** | **String** | Indicates whether the PGRFA currently exists. Allowed value is y/n |  [optional]
+**acquisition** | [**Acquisition**](Acquisition.md) |  |  [optional]
+**collection** | [**Collection**](Collection.md) |  |  [optional]
+**breeding** | [**Breeding**](Breeding.md) |  |  [optional]



--- a/docs/ManagerApi.md
+++ b/docs/ManagerApi.md
@@ -4,8 +4,8 @@ All URIs are relative to *https://glistest.planttreaty.org*

 Method | HTTP request | Description
 ------------- | ------------- | -------------
-[**registerPGRFA**](ManagerApi.md#registerPGRFA) | **POST** /glis/xml/manager | Register PGRFA in GLIS and (potentially) obtain GLIS-minted DOI
-[**updatePGRFA**](ManagerApi.md#updatePGRFA) | **POST** /glis/xml/manager/update | Update PGRFA in GLIS
+[**registerPGRFA**](ManagerApi.md#registerPGRFA) | **POST** /glis/xml/register | Register PGRFA in GLIS and (potentially) obtain GLIS-minted DOI
+[**updatePGRFA**](ManagerApi.md#updatePGRFA) | **POST** /glis/xml/update | Update PGRFA in GLIS


 <a name="registerPGRFA"></a>

--- a/docs/Registration.md
+++ b/docs/Registration.md
@@ -6,19 +6,27 @@ Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **username** | **String** |  |  [optional]
 **password** | **String** |  |  [optional]
-**sampledoi** | [**UUID**](UUID.md) | A Digital Object Identifier (DOI) obtained from a service other than GLIS and that is already assigned to the PGRFA. |  [optional]
-**sampleid** | **String** |  |  [optional]
 **location** | [**Location**](Location.md) |  |  [optional]
+**sampledoi** | **String** | A Digital Object Identifier (DOI) obtained from a service other than GLIS and that is already assigned to the PGRFA. |  [optional]
+**sampleid** | **String** | A string that identifies the PGRFA that is being registered. This value will be returned by GLIS in the response message and is assumed to be used to associate the DOI to the corresponding material in the local database. You must provide &lt;sampleid&gt; even if &lt;sampledoi&gt; is provided. In case you use the DOI as unique identifier in your local database, you can repeat it in &lt;sampleid&gt;. Mandatory. Please read more details in the “HTTPS reply” chapter. |  [optional]
 **date** | **String** | Date in which PGRFA became part of the collection. Date fragments (YYYY-MM and YYYY) are also accepted. |  [optional]
-**genus** | **String** |  |  [optional]
-**cropname** | **String** |  |  [optional]
-**species** | **String** |  |  [optional]
-**spauth** | **String** |  |  [optional]
-**subtaxa** | **String** |  |  [optional]
-**stauth** | **String** |  |  [optional]
-**method** | **String** |  |  [optional]
-**biostatus** | **Integer** |  |  [optional]
-**mlsstatus** | **Integer** |  |  [optional]
+**method** | **String** | Method through which the PGRFA has been acquired. Mandatory. |  [optional]
+**genus** | **String** | The taxon of the genus for the PGRFA. At least one between &lt;genus&gt; and &lt;cropname&gt; must be provided. |  [optional]
+**cropnames** | **List&lt;String&gt;** | Common name of the crop. At least one between &lt;genus&gt; and one cropname must be provided. Multiple names are allowed. |  [optional]
+**targets** | [**List&lt;Target&gt;**](Target.md) |  |  [optional]
+**progdoi** | **List&lt;String&gt;** | DOI of the progenitor PGRFA as registered in GLIS. Please note that the number of allowed DOIs depends on the method as follows   * Acquisition - 1 DOI  * In-house copy - 1 DOI  * In-house variant - 1 DOI  * Novel distinct PGRFA - 1 or more DOIs  * Observation - Natural - 0 DOI  * Observation – Inherited - 0 DOI |  [optional]
+**biostatus** | **Integer** | Biological status of the PGRFA. |  [optional]
+**species** | **String** | Specific epithet of the PGRFA scientific name. If not provided, \&quot;sp.\&quot; is assumed. |  [optional]
+**spauth** | **String** | Authority for the specific epithet. |  [optional]
+**subtaxa** | **String** | Any additional infra-specific taxon such as subspecies, variety, form, Group and so on. |  [optional]
+**stauth** | **String** | Authority for the subtaxon at the most detailed level provided. |  [optional]
+**names** | **List&lt;String&gt;** | Other name of the PGRFA. Any number of names can be provided. |  [optional]
+**ids** | **List&lt;String&gt;** |  |  [optional]
+**mlsstatus** | **Integer** | Code that identifies the status of the PGRFA with regard to the MLS. |  [optional]
+**historical** | **String** | Indicates whether the PGRFA currently exists. Allowed value is y/n |  [optional]
+**acquisition** | [**Acquisition**](Acquisition.md) |  |  [optional]
+**collection** | [**Collection**](Collection.md) |  |  [optional]
+**breeding** | [**Breeding**](Breeding.md) |  |  [optional]



--- a/docs/UpdateInformation.md
+++ b/docs/UpdateInformation.md
@@ -4,8 +4,8 @@
 ## Properties
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
-**modified** | [**DateTime**](DateTime.md) | The date of last change. |  [optional]
-**doiregistered** | [**DateTime**](DateTime.md) | The date of DOI registration to the DataCite registry. If this element is missing or null, the DOI has not been registered yet and should therefore not be used in publications |  [optional]
+**modified** | [**OffsetDateTime**](OffsetDateTime.md) | The date of last change. |  [optional]
+**doiregistered** | [**OffsetDateTime**](OffsetDateTime.md) | The date of DOI registration to the DataCite registry. If this element is missing or null, the DOI has not been registered yet and should therefore not be used in publications |  [optional]