View the WSDL for the service. Click on an operation name to view it's details.

• getAphiaID
Close

Name: getAphiaID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaID
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaIDRequest
  parts:
    scientificname: xsd:string
    marine_only: xsd:boolean
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaID
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaIDResponse
  parts:
    return: xsd:int
Namespace: http://aphia/v1.0/AphiaID
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get the (first) exact matching AphiaID for a given name.
Parameters:
• marine_only: limit to marine taxa. Default=true.


• getAphiaRecords
Close

Name: getAphiaRecords
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaRecords
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordsRequest
  parts:
    scientificname: xsd:string
    like: xsd:boolean
    fuzzy: xsd:boolean
    marine_only: xsd:boolean
    offset: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordsResponse
  parts:
    return: tns:AphiaRecords
Namespace: http://aphia/v1.0/AphiaRecords
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get one or more matching (max. 50) AphiaRecords for a given name.
Parameters:
• like: add a '%'-sign added after the ScientificName (SQL LIKE function). Default=true.
• fuzzy: fuzzy matching. Default=true.
• marine_only: limit to marine taxa. Default=true.
• offset: starting recordnumber, when retrieving next chunck of (50) records. Default=1.


• getAphiaNameByID
Close

Name: getAphiaNameByID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaNameByID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaName
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaNameByIDRequest
  parts:
    AphiaID: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaName
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaNameByIDResponse
  parts:
    return: xsd:string
Namespace: http://aphia/v1.0/AphiaName
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get the correct name for a given AphiaID.

• getAphiaRecordByID
Close

Name: getAphiaRecordByID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaRecordByID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecord
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordByIDRequest
  parts:
    AphiaID: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecord
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordByIDResponse
  parts:
    return: tns:AphiaRecord
Namespace: http://aphia/v1.0/AphiaRecord
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get the complete Aphia Record for a given AphiaID.

• getAphiaRecordByTSN
Close

Name: getAphiaRecordByTSN
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaRecordByTSN
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecord
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordByTSNRequest
  parts:
    TSN: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecord
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordByTSNResponse
  parts:
    return: tns:AphiaRecord
Namespace: http://aphia/v1.0/AphiaRecord
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get the Aphia Record for a given TSN (ITIS Taxonomic Serial Number).

• getAphiaRecordsByNames
Close

Name: getAphiaRecordsByNames
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaRecordsByNames
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaMatches
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordsByNamesRequest
  parts:
    scientificnames: tns:scientificnames
    like: xsd:boolean
    fuzzy: xsd:boolean
    marine_only: xsd:boolean
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaMatches
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordsByNamesResponse
  parts:
    return: tns:AphiaMatches
Namespace: http://aphia/v1.0/AphiaMatches
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: For each given scientific name, try to find one or more AphiaRecords.
This allows you to match multiple names in one call. Limited to 500 names at once for performance reasons.
Parameters:
• like: add a '%'-sign after the ScientificName (SQL LIKE function). Default=false.
• fuzzy: fuzzy matching. Default=true.
• marine_only: limit to marine taxa. Default=true.


• getAphiaRecordsByVernacular
Close

Name: getAphiaRecordsByVernacular
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaRecordsByVernacular
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordsByVernacularRequest
  parts:
    vernacular: xsd:string
    like: xsd:boolean
    offset: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaRecordsByVernacularResponse
  parts:
    return: tns:AphiaRecords
Namespace: http://aphia/v1.0/AphiaRecords
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get one or more Aphia Records (max. 50) for a given vernacular.
Parameters:
• like: add a '%'-sign before and after the input (SQL LIKE '%vernacular%' function). Default=false.
• offset: starting record number, when retrieving next chunck of (50) records. Default=1.


• getAphiaClassificationByID
Close

Name: getAphiaClassificationByID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaClassificationByID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/Classification
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaClassificationByIDRequest
  parts:
    AphiaID: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/Classification
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaClassificationByIDResponse
  parts:
    return: tns:Classification
Namespace: http://aphia/v1.0/Classification
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get the complete classification for one taxon. This also includes any sub or super ranks.

• getSourcesByAphiaID
Close

Name: getSourcesByAphiaID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getSourcesByAphiaID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/Sources
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getSourcesByAphiaIDRequest
  parts:
    AphiaID: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/Sources
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getSourcesByAphiaIDResponse
  parts:
    return: tns:Sources
Namespace: http://aphia/v1.0/Sources
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get one or more sources/references including links, for one AphiaID

• getAphiaSynonymsByID
Close

Name: getAphiaSynonymsByID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaSynonymsByID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaSynonymsByIDRequest
  parts:
    AphiaID: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaSynonymsByIDResponse
  parts:
    return: tns:AphiaRecords
Namespace: http://aphia/v1.0/AphiaRecords
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get all synonyms for a given AphiaID.

• getAphiaVernacularsByID
Close

Name: getAphiaVernacularsByID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaVernacularsByID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaVernaculars
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaVernacularsByIDRequest
  parts:
    AphiaID: xsd:int
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaVernaculars
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaVernacularsByIDResponse
  parts:
    return: tns:Vernaculars
Namespace: http://aphia/v1.0/AphiaVernaculars
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get all vernaculars for a given AphiaID.

• getAphiaChildrenByID
Close

Name: getAphiaChildrenByID
Binding: AphiaNameServiceBinding
Endpoint: http://www.marinespecies.org/aphia.php?p=soap
SoapAction: getAphiaChildrenByID
Style: rpc
Input:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaChildrenByIDRequest
  parts:
    AphiaID: xsd:int
    offset: xsd:int
    marine_only: xsd:boolean
Output:
  use: encoded
  namespace: http://aphia/v1.0/AphiaRecords
  encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
  message: getAphiaChildrenByIDResponse
  parts:
    return: tns:AphiaRecords
Namespace: http://aphia/v1.0/AphiaRecords
Transport: http://schemas.xmlsoap.org/soap/http
Documentation: Get the direct children (max. 50) for a given AphiaID.
Parameters:
• offset: starting record number, when retrieving next chunck of (50) records. Default=1.
• marine_only: limit to marine taxa. Default=true.