GET api/Service/GetSpecies?hasSearch={hasSearch}&role={role}
Get Speices List
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
hasSearch | boolean | ||
role | string |
Body Parameters
None.
Response Information
Resource Description
Return a List of Speices
ReturnViewModelName | Description | Type | Additional information |
---|---|---|---|
Success |
Success will return True / False based on Request Status |
boolean |
None. |
Result |
Result will be Object based on Request. |
Object |
None. |
Total |
Returns total number of records for list. For example: Airports, Operators Total count. |
integer |
None. |
ErrorMessage |
Returns error meesage if Success is False. |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "Success": true, "Result": {}, "Total": 3, "ErrorMessage": "sample string 4" }
text/html
Sample:
{"Success":true,"Result":{},"Total":3,"ErrorMessage":"sample string 4"}
application/xml, text/xml
Sample:
<ReturnViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Faa.wildlife.ResfulAPIService.Models"> <ErrorMessage>sample string 4</ErrorMessage> <Result /> <Success>true</Success> <Total>3</Total> </ReturnViewModel>