DATRAS

• Print it
• Send to
• Share it

DATRAS webservices DATRAS Web Services offer a possibility to search and retrieve data from DATRAS database by granting direct access to the data. Each part of the web services is provided by a web service API, which defines the name, input to, and output from the service for a particular data request. This page lists all the DATRAS Web Service APIs with the description of the particular API service, the input needed to get data, and the data output information. DATRAS Web Services are also fully described by a Web Service Description Language (WSDL) document that can be used to create clients that access the service. All codes and units from the data output can be found at the (DATRAS units document), also accessible through the Documents page. The following web service APIs are provided:          Name  getHHdata(survey,year,quarter)   Description This API of the webservice returns the url to the Haul-based information for the given survey, year, and quarter.   Input Survey acronym (e.g. NS-IBTS,BITS) Year (e.g. 2010,2011 ) Quarter ( e.g. 1,2,3,4)   Output Returns detailed haul-based meta-data of the survey such as haul position, sampling method etc.   Example Haul based data for survey=NS-IBTS,year=1966 and quarter=1              Name  getHLdata(survey,year,quarter)   Description This API of the webservice returns the url to the Length-based species information for the given survey, year, and quarter.   Input Survey acronym (e.g. NS-IBTS,BITS) Year (e.g. 2010,2011 ) Quarter ( e.g. 1,2,3,4)   Output Returns length-based information such as measured length, individual counts, and subfactors of sampled species.   Example Length based data for survey=NS-IBTS,year=1966 and quarter=1          Name  getCAdata(survey,year,quarter)   Description This API of the webservice returns the url to the Age-based species information for the given survey, year, and quarter.   Input Survey acronym (e.g. NS-IBTS,BITS) Year (e.g. 2010,2011 ) Quarter ( e.g. 1,2,3,4)   Output Returns age-based information such as sex, maturity, and age counts per length of sampled species.   Example Age based data for survey=NS-IBTS,year=1966 and quarter=1    Name  getSurveyInsertDate(survey,year,quarter,ship,country)   Description This API of the webservice returns url of the insertion date for the given survey, year, quarter,ship and country.   Input Survey acronym (e.g. NS-IBTS) Year (e.g. 2010 ) Quarter ( e.g. 1) Ship ( e.g. DAN2) Country ( e.g. DEN)   Output Returns datetime of individual submission.   Example Submission date of survey=NS-IBTS,year=2010,quarter=1,ship = DAN2 and country= DEN    Name  getSurveyList()   Description This API of the webservice returns the url of the names of the survey in the DATRAS database   Output Returns survey names list.   Example Survey names    Name  getSurveyYearList(survey)   Description This API of the webservice returns the url of the years of given survey.   Input Survey acronym (e.g. NS-IBTS)   Output Returns years list of survey.   Example years of survey=NS-IBTS    Name  getSurveyYearQuarterList(survey,year)   Description This API of the webservice returns the url of quarter of given survey and year.   Input Survey acronym (e.g. NS-IBTS) Year (e.g. 2010 )   Output Returns list of quarter based on survey and year.   Example quarter of survey=NS-IBTS,year=2010    Name  getIndices(survey,year,quarter,species)   Description This API of the webservice returns the url of quarter of given survey,year,quarter and species.   Input Survey acronym (e.g. NS-IBTS) Year (e.g. 2010 ) Quarter (e.g. 3 ) Species (e.g. 126436 ) it need to be in AphiaID   Output Returns Survey Indices based on survey,year,quarter and species.   Example quarter of survey=NS-IBTS,year=2010,quarter=1 and species = 126436    Name  getLitterAssessmentOutput(survey,year,quarter)   Description This API of the webservice returns the url of Litter assessment units for the given survey, year and quarter.   Input Survey acronym (e.g. NS-IBTS,BITS) Year (e.g. 2010,2011 ) Quarter ( e.g. 1,2,3,4)   Output Returns combine data of Haul ,Litter and calculated fields (e.g.Wingspread,DoorSpread,Distance,EEZ,NMarea,OsparArea,MSFDArea,BottomDepth)   Example Litter assessment output for survey=NS-IBTS,year=2017 and quarter=1    Name  getLitterAssessmentOutputByUpdateDate(dateofcalculation)   Description This API of the webservice returns the url of Litter assessment units for the given dateofcalculation.   Input DateofCalculation (e.g. 20170914)   Output Returns combine data of Haul ,Litter and calculated fields (e.g.Wingspread,DoorSpread,Distance,EEZ,NMarea,OsparArea,MSFDArea,BottomDepth)   Example Litter assessment output for DateofCalculation=20170914    Name  getListofDateofCalculation()   Description This API of the webservice returns the url of list of Date of Calculation of data product.   Output Returns full list of Date of Calculation of data products.   Example List of Date of Calculation    Name  getLengthAgeSummary(country,year)   Description This API of the webservice returns the url of length age summary of given country and year.   Input Country (e.g. DEN) Year (e.g. 2010 )   Output Returns summary of total no of individual measuerd by weight,sex,maturity,age and length.   Example quarter of survey=NS-IBTS,year=2010    Name  getCPUEPerAgePerHaulPerHour(survey,year,quarter)   Description This API of the webservice returns the url of quarter of given survey,year and quarter.   Input Survey acronym (e.g. BITS) Year (e.g. 2010 ) Quarter (e.g. 1 )   Output Returns CPUEPerAgePerHaulPerHour based on survey,year and quarter.   Example quarter of survey=BITS,year=2010 and quarter=1    getCPUEPerLengthPerHaulPerHour(survey,year,quarter)   Description This API of the webservice returns the url of quarter of given survey,year and quarter.   Input Survey acronym (e.g. BITS) Year (e.g. 2010 ) Quarter (e.g. 1 )   Output Returns CPUEPerLengthPerHaulPerHour based on survey,year and quarter.   Example quarter of survey=BITS,year=2010 and quarter=1    getFlexFile(survey,year,quarter)   Description This API of the webservice returns the url of quarter of given survey,year and quarter.   Input Survey acronym (e.g. NS-IBTS) Year (e.g. 2010 ) Quarter (e.g. 1 )   Output Returns FlexFile contains swept area data, based on survey,year and quarter.   Example quarter of survey=NS-IBTS,year=2010 and quarter=1    getSubmissionStatus_FishTrawlData   Description This API of the webservice returns FishTrawlData submission status.   Output Returns list of Survey,Year,Quarter,Ship,Gear,NoofHauls,Insertion_date.   Example List of Submission Status    getSubmissionStatus_LitterData   Description This API of the webservice returns LitterData submission status.   Output Returns list of Survey,Year,Quarter,Ship,Gear,NoofHauls,Insertion_date.   Example List of Submission Status

Download data products Upload survey data VIEW ON MAP CONNECT TO WebServices Contact us Useful links Unified format description DATRAS comparison reports app Mandatory fields per survey DATRAS vocabularies Data submission deadlines Submission status icesDATRAS R package Metadata of the datasets DATRAS Survey Areas Widget Working Group on DATRAS Governance VIEW MORE Background documents News and updates ICES DATRAS Data flow schematics DATA ACCESS ICES Data Policy CC BY 4.0 (for open access data)