This website does readability filtering of other pages. All styles, scripts, forms and ads are stripped. If you want your website excluded or have other feedback, use this form.

NuSOAP: AphiaNameService



AphiaNameService

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

  • getAphiaID
  • Close

    Name: getAphiaID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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 IRMNG_ID for a given name. Output: NULL when no match is found; -999 when multiple matches are found; an integer (IRMNG_ID) when one exact match was found
    Parameters:
    • marine_only: Limit to marine taxa. Default=true

    Returns:
    • NULL when no match is found
    • -999 when multiple matches are found
    • an integer (IRMNG_ID) when one exact match was found

  • getAphiaRecords
  • Close

    Name: getAphiaRecords
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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: This parameter is deprecated (and ignored since '2013-07-17'). Please use the function matchAphiaRecordsByNames() for fuzzy/near matching
    • marine_only: Limit to marine taxa. Default=true
    • offset: Starting recordnumber, when retrieving next chunk of (50) records. Default=1

    For the structure of the returned AphiaRecords, please refer to the function getAphiaRecordByID()
  • getAphiaNameByID
  • Close

    Name: getAphiaNameByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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:
        IRMNG_ID: 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 name for a given IRMNG_ID.
  • getAphiaRecordByID
  • Close

    Name: getAphiaRecordByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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:
        IRMNG_ID: 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 AphiaRecord for a given IRMNG_ID
    The returned AphiaRecord has this format:
    • IRMNG_ID : Unique and persistent identifier within IRMNG. Primary key in the database
    • url : HTTP URL to the AphiaRecord
    • scientificname : the full scientific name without authorship
    • authority : the authorship information for the scientificname formatted according to the conventions of the applicable nomenclaturalCode
    • taxonRankID : the taxonomic rank identifier of the most specific name in the scientificname
    • rank : the taxonomic rank of the most specific name in the scientificname
    • status : the status of the use of the scientificname (usually a taxonomic opinion). Additional technical statuses are (1) quarantined: hidden from public interface after decision from an editor and (2) deleted: IRMNG_ID should NOT be used anymore, please replace it by the valid_IRMNG_ID
    • unacceptreason : the reason why a scientificname is unaccepted
    • valid_IRMNG_ID : the IRMNG_ID (for the scientificname) of the currently accepted taxon. NULL if there is no currently accepted taxon.
    • valid_name : the scientificname of the currently accepted taxon
    • valid_authority : the authorship information for the scientificname of the currently accepted taxon
    • parentNameUsageID : the IRMNG_ID (for the scientificname) of the direct, most proximate higher-rank parent taxon (in a classification)
    • kingdom : the full scientific name of the kingdom in which the taxon is classified
    • phylum : the full scientific name of the phylum or division in which the taxon is classified
    • class : the full scientific name of the class in which the taxon is classified
    • order : the full scientific name of the order in which the taxon is classified
    • family : the full scientific name of the family in which the taxon is classified
    • genus : the full scientific name of the genus in which the taxon is classified
    • citation : a bibliographic reference for the resource as a statement indicating how this record should be cited (attributed) when used
    • lsid : LifeScience Identifier. Persistent GUID for an IRMNG_ID
    • isMarine : a boolean flag indicating whether the taxon is a marine organism, i.e. can be found in/above sea water. Possible values: 0/1/NULL
    • isBrackish : a boolean flag indicating whether the taxon occurrs in brackish habitats. Possible values: 0/1/NULL
    • isFreshwater : a boolean flag indicating whether the taxon occurrs in freshwater habitats, i.e. can be found in/above rivers or lakes. Possible values: 0/1/NULL
    • isTerrestrial : a boolean flag indicating the taxon is a terrestial organism, i.e. occurrs on land as opposed to the sea. Possible values: 0/1/NULL
    • isExtinct : a flag indicating an extinct organism. Possible values: 0/1/NULL
    • match_type : Type of match. Possible values: exact/like/phonetic/near_1/near_2
    • modified : The most recent date-time in GMT on which the resource was changed

  • getAphiaRecordsByIDs
  • Close

    Name: getAphiaRecordsByIDs
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getAphiaRecordsByIDs
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecords
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordsByIDsRequest
      parts:
        irmng_ids: tns:irmng_ids
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecords
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordsByIDsResponse
      parts:
        return: tns:AphiaRecords
    Namespace: http://aphia/v1.0/AphiaRecords
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: Get an AphiaRecord for multiple IRMNG_IDs in one go (max: 50)
    For the structure of the returned AphiaRecords, please refer to the function getAphiaRecordByID()
  • getAphiaRecordByExtID
  • Close

    Name: getAphiaRecordByExtID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getAphiaRecordByExtID
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecord
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordByExtIDRequest
      parts:
        id: xsd:string
        type: xsd:string
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecord
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordByExtIDResponse
      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 external identifier
    Parameters:
    • Type: Type of external identifier to search for. The type should be one of the following values:
      • algaebase: Algaebase species ID
      • bold: Barcode of Life Database (BOLD) TaxID
      • dyntaxa: Dyntaxa ID
      • eol: Encyclopedia of Life (EoL) page identifier
      • fishbase: FishBase species ID
      • iucn: IUCN Red List Identifier
      • lsid: Life Science Identifier
      • ncbi: NCBI Taxonomy ID (Genbank)
      • tsn: ITIS Taxonomic Serial Number
      • gisd: Global Invasive Species Database

  • getExtIDbyAphiaID
  • Close

    Name: getExtIDbyAphiaID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getExtIDbyAphiaID
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/externalidentifiers
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getExtIDbyAphiaIDRequest
      parts:
        IRMNG_ID: xsd:int
        type: xsd:string
    Output:
      use: encoded
      namespace: http://aphia/v1.0/externalidentifiers
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getExtIDbyAphiaIDResponse
      parts:
        return: tns:externalidentifiers
    Namespace: http://aphia/v1.0/externalidentifiers
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: Get any external identifier(s) for a given IRMNG_ID
    Parameters:
    • Type: Type of external identifier to return. The type should be one of the following values:
      • algaebase: Algaebase species ID
      • bold: Barcode of Life Database (BOLD) TaxID
      • dyntaxa: Dyntaxa ID
      • eol: Encyclopedia of Life (EoL) page identifier
      • fishbase: FishBase species ID
      • iucn: IUCN Red List Identifier
      • lsid: Life Science Identifier
      • ncbi: NCBI Taxonomy ID (Genbank)
      • tsn: ITIS Taxonomic Serial Number
      • gisd: Global Invasive Species Database

  • getAphiaRecordsByNames
  • Close

    Name: getAphiaRecordsByNames
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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: This parameter is deprecated (and ignored since '2013-07-17'). Please use the function matchAphiaRecordsByNames() for fuzzy/near matching
    • marine_only: Limit to marine taxa. Default=true

    For the structure of the returned AphiaRecords, please refer to the function getAphiaRecordByID()
  • getAphiaRecordsByVernacular
  • Close

    Name: getAphiaRecordsByVernacular
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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 recordnumber, when retrieving next chunk of (50) records. Default=1

    For the structure of the returned AphiaRecords, please refer to the function getAphiaRecordByID()
  • getAphiaRecordsByDate
  • Close

    Name: getAphiaRecordsByDate
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getAphiaRecordsByDate
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecords
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordsByDateRequest
      parts:
        startdate: xsd:string
        enddate: xsd:string
        marine_only: xsd:boolean
        offset: xsd:int
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecords
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordsByDateResponse
      parts:
        return: tns:AphiaRecords
    Namespace: http://aphia/v1.0/AphiaRecords
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: Lists all AphiaRecords (taxa) that have their last edit action (modified or added) during the specified period
    Parameters:
    • startdate: ISO 8601 formatted start date(time). Default=today(). i.e. 2020-08-05T21:30:57+00:00
    • enddate: ISO 8601 formatted end date(time). Default=today().i.e. 2020-08-05T21:30:57+00:00
    • marine_only: Limit to marine taxa. Default=true
    • offset: Starting recordnumber, when retrieving next chunk of (50) records. Default=1

    For the structure of the returned AphiaRecords, please refer to the function getAphiaRecordByID()
  • getAphiaClassificationByID
  • Close

    Name: getAphiaClassificationByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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:
        IRMNG_ID: 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: https://www.irmng.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:
        IRMNG_ID: 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 IRMNG_ID
    Output fields include:
    • source_id : Unique identifier for the source within IRMNG
    • use : Usage of the source for this taxon. See here for all values
    • reference : Full citation string
    • page : Page(s) where the taxon is mentioned
    • url : Direct link to the source record
    • link : External link (i.e. journal, data system, etc..)
    • fulltext : Full text link (PDF)
    • doi : Digital Object Identifier

  • getAphiaSynonymsByID
  • Close

    Name: getAphiaSynonymsByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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:
        IRMNG_ID: xsd:int
        offset: 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 IRMNG_ID
    Parameters:
    • offset: Starting recordnumber, when retrieving next chunk of (50) records. Default=1

  • getAphiaVernacularsByID
  • Close

    Name: getAphiaVernacularsByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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:
        IRMNG_ID: 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 IRMNG_ID
  • getAphiaChildrenByID
  • Close

    Name: getAphiaChildrenByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.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:
        IRMNG_ID: 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 IRMNG_ID
    Parameters:
    • offset: Starting recordnumber, when retrieving next chunk of (50) records. Default=1
    • marine_only: Limit to marine taxa. Default=true

  • matchAphiaRecordsByNames
  • Close

    Name: matchAphiaRecordsByNames
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: matchAphiaRecordsByNames
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaMatches
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: matchAphiaRecordsByNamesRequest
      parts:
        scientificnames: tns:scientificnames
        marine_only: xsd:boolean
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaMatches
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: matchAphiaRecordsByNamesResponse
      parts:
        return: tns:AphiaMatches
    Namespace: http://aphia/v1.0/AphiaMatches
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: For each given scientific name (may include authority), try to find one or more AphiaRecords, using the TAXAMATCH fuzzy matching algorithm by Tony Rees.
    This allows you to (fuzzy) match multiple names in one call. Limited to 50 names at once for performance reasons

    Parameters:
    • marine_only: Limit to marine taxa. Default=true

    For the structure of the returned AphiaRecords, please refer to the function getAphiaRecordByID()
  • getAphiaDistributionsByID
  • Close

    Name: getAphiaDistributionsByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getAphiaDistributionsByID
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaDistributions
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaDistributionsByIDRequest
      parts:
        AphiaID: xsd:int
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaDistributions
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaDistributionsByIDResponse
      parts:
        return: tns:Distributions
    Namespace: http://aphia/v1.0/AphiaDistributions
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: Get all distributions for a given IRMNG_ID
    Output fields include:
    • locality : The specific description of the place
    • locationID : An identifier for the locality. Using the Marine Regions Geographic IDentifier (MRGID), see [www.marineregions.org]
    • higherGeography : A geographic name less specific than the information captured in the locality term. Possible values: an IHO Sea Area or Nation, derived from the MarineRegions gazetteer
    • higherGeographyID : An identifier for the geographic region within which the locality occurred, using MRGID
    • recordStatus : The status of the distribution record. Possible values are 'valid' ,'doubtful' or 'inaccurate'. See here for explanation of the statuses
    • typeStatus : The type status of the distribution. Possible values: 'holotype' or empty.
    • establishmentMeans : The process by which the biological individual(s) represented in the Occurrence became established at the location. Possible values: values listed as Origin in WRIMS
    • decimalLatitude : The geographic latitude (in decimal degrees, WGS84)
    • decimalLongitude : The geographic longitude (in decimal degrees, WGS84)
    • qualityStatus : Quality status of the record. Possible values: 'checked', 'trusted' or 'unreviewed'. See [www.irmng.org]

  • getAphiaTaxonRanksByID
  • Close

    Name: getAphiaTaxonRanksByID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getAphiaTaxonRanksByID
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRanks
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaTaxonRanksByIDRequest
      parts:
        taxonRankID: xsd:int
        IRMNG_ID: xsd:int
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRanks
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaTaxonRanksByIDResponse
      parts:
        return: tns:AphiaRanks
    Namespace: http://aphia/v1.0/AphiaRanks
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: Get taxonomic ranks by their identifier
    Output fields include:
    • taxonRankID : A taxonomic rank identifier
    • taxonRank : A taxonomic rank name
    • IRMNG_ID : IRMNG_ID of the kingdom
    • kingdom : The name of a taxonomic kingdom the rank is used in

  • getAphiaTaxonRanksByName
  • Close

    Name: getAphiaTaxonRanksByName
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getAphiaTaxonRanksByName
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRanks
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaTaxonRanksByNameRequest
      parts:
        taxonRank: xsd:string
        IRMNG_ID: xsd:int
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRanks
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaTaxonRanksByNameResponse
      parts:
        return: tns:AphiaRanks
    Namespace: http://aphia/v1.0/AphiaRanks
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: Get taxonomic ranks by their name
    Output fields include:
    • taxonRankID : A taxonomic rank identifier
    • taxonRank : A taxonomic rank name
    • IRMNG_ID : IRMNG_ID of the kingdom
    • kingdom : The name of a taxonomic kingdom the rank is used in

  • getAphiaRecordsByTaxonRankID
  • Close

    Name: getAphiaRecordsByTaxonRankID
    Binding: AphiaNameServiceBinding
    Endpoint: https://www.irmng.org/aphia.php?p=soap
    SoapAction: getAphiaRecordsByTaxonRankID
    Style: rpc
    Input:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecords
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordsByTaxonRankIDRequest
      parts:
        taxonRankID: xsd:int
        belongsTo: xsd:int
        offset: xsd:int
    Output:
      use: encoded
      namespace: http://aphia/v1.0/AphiaRecords
      encodingStyle: http://schemas.xmlsoap.org/soap/encoding/
      message: getAphiaRecordsByTaxonRankIDResponse
      parts:
        return: tns:AphiaRecords
    Namespace: http://aphia/v1.0/AphiaRecords
    Transport: http://schemas.xmlsoap.org/soap/http
    Documentation: Get the AphiaRecords for a given taxonRankID (max 50)
    Output fields include:
    For the structure of the returned AphiaRecords, please refer to the function getAphiaRecordByID()