FootprintServices


Click here for a complete list of operations.

FindByKeyword

Returns all footprints with matching descriptions to the specified keyword(s).
Input 1: The user ID (type of string)
Input 2: The keywords (type of string)
Output: The footprint headers (type of Footprint[])

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.
Parameter Value
userGuid:
keyword:

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 /footprint/ws_v1_1/FootprintServices.asmx HTTP/1.1
Host: voservices.net
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "ivo://voservices.net/footprint/FindByKeyword"

<?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>
    <FindByKeyword xmlns="ivo://voservices.net/footprint">
      <userGuid>string</userGuid>
      <keyword>string</keyword>
    </FindByKeyword>
  </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>
    <FindByKeywordResponse xmlns="ivo://voservices.net/footprint">
      <FindByKeywordResult>
        <Footprint>
          <STCRegion>
            <AstroCoordSystem xsi:nil="true" xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd" />
          </STCRegion>
        </Footprint>
        <Footprint>
          <STCRegion>
            <AstroCoordSystem xsi:nil="true" xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd" />
          </STCRegion>
        </Footprint>
      </FindByKeywordResult>
    </FindByKeywordResponse>
  </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 /footprint/ws_v1_1/FootprintServices.asmx HTTP/1.1
Host: voservices.net
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>
    <FindByKeyword xmlns="ivo://voservices.net/footprint">
      <userGuid>string</userGuid>
      <keyword>string</keyword>
    </FindByKeyword>
  </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>
    <FindByKeywordResponse xmlns="ivo://voservices.net/footprint">
      <FindByKeywordResult>
        <Footprint>
          <STCRegion>
            <AstroCoordSystem xsi:nil="true" xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd" />
          </STCRegion>
        </Footprint>
        <Footprint>
          <STCRegion>
            <AstroCoordSystem xsi:nil="true" xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd" />
          </STCRegion>
        </Footprint>
      </FindByKeywordResult>
    </FindByKeywordResponse>
  </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 /footprint/ws_v1_1/FootprintServices.asmx/FindByKeyword?userGuid=string&keyword=string HTTP/1.1
Host: voservices.net
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfFootprint xmlns="ivo://voservices.net/footprint">
  <Footprint>
    <STCRegion>
      <AstroCoordSystem xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd">
        <TimeFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpaceFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpectralFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RedshiftFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </AstroCoordSystem>
    </STCRegion>
  </Footprint>
  <Footprint>
    <STCRegion>
      <AstroCoordSystem xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd">
        <TimeFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpaceFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpectralFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RedshiftFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </AstroCoordSystem>
    </STCRegion>
  </Footprint>
</ArrayOfFootprint>

HTTP POST

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

POST /footprint/ws_v1_1/FootprintServices.asmx/FindByKeyword HTTP/1.1
Host: voservices.net
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfFootprint xmlns="ivo://voservices.net/footprint">
  <Footprint>
    <STCRegion>
      <AstroCoordSystem xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd">
        <TimeFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpaceFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpectralFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RedshiftFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </AstroCoordSystem>
    </STCRegion>
  </Footprint>
  <Footprint>
    <STCRegion>
      <AstroCoordSystem xmlns="http://www.ivoa.net/xml/STC/stc-v1.30.xsd">
        <TimeFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpaceFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <SpectralFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <RedshiftFrame d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </AstroCoordSystem>
    </STCRegion>
  </Footprint>
</ArrayOfFootprint>