API


Click here for a complete list of operations.

GetSearchResultHeaders

Returns a Document (JSON, XML or InternalUse) representing parameters for search contacts

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
StringOfJSONParameters:
DBName:
AsType:

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /DesktopModules/NOAH_Common/WebServices/API.asmx HTTP/1.1
Host: my.americanornithology.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://ams.enoah.com/API/GetSearchResultHeaders"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSearchResultHeaders xmlns="http://ams.enoah.com/API/GetSearchResultHeadersRequestData">
      <StringOfJSONParameters>string</StringOfJSONParameters>
      <DBName>string</DBName>
      <AsType>JSON or XML or InternalUse</AsType>
    </GetSearchResultHeaders>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetSearchResultHeaders xmlns="http://ams.enoah.com/API/GetSearchResultHeadersResponseData">
      <GetSearchResultHeadersResult />
    </GetSearchResultHeaders>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /DesktopModules/NOAH_Common/WebServices/API.asmx HTTP/1.1
Host: my.americanornithology.org
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSearchResultHeaders xmlns="http://ams.enoah.com/API/GetSearchResultHeadersRequestData">
      <StringOfJSONParameters>string</StringOfJSONParameters>
      <DBName>string</DBName>
      <AsType>JSON or XML or InternalUse</AsType>
    </GetSearchResultHeaders>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetSearchResultHeaders xmlns="http://ams.enoah.com/API/GetSearchResultHeadersResponseData">
      <GetSearchResultHeadersResult />
    </GetSearchResultHeaders>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.

GET /DesktopModules/NOAH_Common/WebServices/API.asmx/GetSearchResultHeaders?StringOfJSONParameters=string&DBName=string&AsType=string HTTP/1.1
Host: my.americanornithology.org
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<anyType xmlns="http://ams.enoah.com/API" />

HTTP POST

The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.

POST /DesktopModules/NOAH_Common/WebServices/API.asmx/GetSearchResultHeaders HTTP/1.1
Host: my.americanornithology.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

StringOfJSONParameters=string&DBName=string&AsType=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<anyType xmlns="http://ams.enoah.com/API" />