HistologyWebService Web Service

HistologyWebService

Click here for a complete list of operations.

GetHistologyImagesBySearch

This method will return a list of Histology Images that meet the optional HistologyImage Search criteria

Test

The test form is only available for requests from the local machine.

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 /webservices/HistologyWebService.asmx HTTP/1.1
Host: www.amdcc.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.amdcc.org/webservices/GetHistologyImagesBySearch"

<?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>
    <GetHistologyImagesBySearch xmlns="http://www.amdcc.org/webservices/">
      <histologyImageSearch>
        <ModelTypeID />
        <SpeciesID />
        <AnimalID />
        <ExperimentID />
        <StrainID />
        <InvestigatorID />
        <SampleSourceID />
        <StainingProtocolID />
        <Keywords>string</Keywords>
        <IsAvailable>boolean</IsAvailable>
        <Page>int</Page>
        <Rows>int</Rows>
        <CreatedFromDate>dateTime</CreatedFromDate>
        <CreatedToDate>dateTime</CreatedToDate>
      </histologyImageSearch>
    </GetHistologyImagesBySearch>
  </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>
    <GetHistologyImagesBySearchResponse xmlns="http://www.amdcc.org/webservices/">
      <GetHistologyImagesBySearchResult>
        <HistologyImage>
          <Animal>
            <Name>string</Name>
            <Sex>Male or Female or Unknown</Sex>
            <BirthDate>dateTime</BirthDate>
            <DeathDate>dateTime</DeathDate>
          </Animal>
          <AnimalAge>
            <Unit xsi:nil="true" />
            <Value>double</Value>
            <MinValue>double</MinValue>
            <MaxValue>double</MaxValue>
          </AnimalAge>
          <Experiment>
            <Name>string</Name>
            <TypeName>string</TypeName>
            <Description>string</Description>
            <Species xsi:nil="true" />
            <ModelTypeName>string</ModelTypeName>
            <AnimalAgeUnit xsi:nil="true" />
            <StatusName>string</StatusName>
            <PublicReleaseDate>dateTime</PublicReleaseDate>
            <MaleCount>int</MaleCount>
            <FemaleCount>int</FemaleCount>
            <HistologyCount>int</HistologyCount>
            <BioAssayCount>int</BioAssayCount>
            <PhenotypeDatumCount>int</PhenotypeDatumCount>
          </Experiment>
          <SampleSourceID />
          <SampleSourceName>string</SampleSourceName>
          <SampleDate>dateTime</SampleDate>
          <SlidePrepDate>dateTime</SlidePrepDate>
          <StainingProtocol>
            <Title>string</Title>
            <TypeName>string</TypeName>
            <Version>short</Version>
            <Description>string</Description>
          </StainingProtocol>
          <Magnification>double</Magnification>
          <ExternalSampleID>string</ExternalSampleID>
          <MicroscopicDescription>string</MicroscopicDescription>
          <GrossDescription>string</GrossDescription>
          <IsAvailable>boolean</IsAvailable>
          <BlockID>string</BlockID>
          <BlockTypeID />
          <BlockTypeName>string</BlockTypeName>
          <SectioningInvestigator>
            <PrincipalInvestigatorID xsi:nil="true" />
          </SectioningInvestigator>
        </HistologyImage>
        <HistologyImage>
          <Animal>
            <Name>string</Name>
            <Sex>Male or Female or Unknown</Sex>
            <BirthDate>dateTime</BirthDate>
            <DeathDate>dateTime</DeathDate>
          </Animal>
          <AnimalAge>
            <Unit xsi:nil="true" />
            <Value>double</Value>
            <MinValue>double</MinValue>
            <MaxValue>double</MaxValue>
          </AnimalAge>
          <Experiment>
            <Name>string</Name>
            <TypeName>string</TypeName>
            <Description>string</Description>
            <Species xsi:nil="true" />
            <ModelTypeName>string</ModelTypeName>
            <AnimalAgeUnit xsi:nil="true" />
            <StatusName>string</StatusName>
            <PublicReleaseDate>dateTime</PublicReleaseDate>
            <MaleCount>int</MaleCount>
            <FemaleCount>int</FemaleCount>
            <HistologyCount>int</HistologyCount>
            <BioAssayCount>int</BioAssayCount>
            <PhenotypeDatumCount>int</PhenotypeDatumCount>
          </Experiment>
          <SampleSourceID />
          <SampleSourceName>string</SampleSourceName>
          <SampleDate>dateTime</SampleDate>
          <SlidePrepDate>dateTime</SlidePrepDate>
          <StainingProtocol>
            <Title>string</Title>
            <TypeName>string</TypeName>
            <Version>short</Version>
            <Description>string</Description>
          </StainingProtocol>
          <Magnification>double</Magnification>
          <ExternalSampleID>string</ExternalSampleID>
          <MicroscopicDescription>string</MicroscopicDescription>
          <GrossDescription>string</GrossDescription>
          <IsAvailable>boolean</IsAvailable>
          <BlockID>string</BlockID>
          <BlockTypeID />
          <BlockTypeName>string</BlockTypeName>
          <SectioningInvestigator>
            <PrincipalInvestigatorID xsi:nil="true" />
          </SectioningInvestigator>
        </HistologyImage>
      </GetHistologyImagesBySearchResult>
    </GetHistologyImagesBySearchResponse>
  </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 /webservices/HistologyWebService.asmx HTTP/1.1
Host: www.amdcc.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>
    <GetHistologyImagesBySearch xmlns="http://www.amdcc.org/webservices/">
      <histologyImageSearch>
        <ModelTypeID />
        <SpeciesID />
        <AnimalID />
        <ExperimentID />
        <StrainID />
        <InvestigatorID />
        <SampleSourceID />
        <StainingProtocolID />
        <Keywords>string</Keywords>
        <IsAvailable>boolean</IsAvailable>
        <Page>int</Page>
        <Rows>int</Rows>
        <CreatedFromDate>dateTime</CreatedFromDate>
        <CreatedToDate>dateTime</CreatedToDate>
      </histologyImageSearch>
    </GetHistologyImagesBySearch>
  </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>
    <GetHistologyImagesBySearchResponse xmlns="http://www.amdcc.org/webservices/">
      <GetHistologyImagesBySearchResult>
        <HistologyImage>
          <Animal>
            <Name>string</Name>
            <Sex>Male or Female or Unknown</Sex>
            <BirthDate>dateTime</BirthDate>
            <DeathDate>dateTime</DeathDate>
          </Animal>
          <AnimalAge>
            <Unit xsi:nil="true" />
            <Value>double</Value>
            <MinValue>double</MinValue>
            <MaxValue>double</MaxValue>
          </AnimalAge>
          <Experiment>
            <Name>string</Name>
            <TypeName>string</TypeName>
            <Description>string</Description>
            <Species xsi:nil="true" />
            <ModelTypeName>string</ModelTypeName>
            <AnimalAgeUnit xsi:nil="true" />
            <StatusName>string</StatusName>
            <PublicReleaseDate>dateTime</PublicReleaseDate>
            <MaleCount>int</MaleCount>
            <FemaleCount>int</FemaleCount>
            <HistologyCount>int</HistologyCount>
            <BioAssayCount>int</BioAssayCount>
            <PhenotypeDatumCount>int</PhenotypeDatumCount>
          </Experiment>
          <SampleSourceID />
          <SampleSourceName>string</SampleSourceName>
          <SampleDate>dateTime</SampleDate>
          <SlidePrepDate>dateTime</SlidePrepDate>
          <StainingProtocol>
            <Title>string</Title>
            <TypeName>string</TypeName>
            <Version>short</Version>
            <Description>string</Description>
          </StainingProtocol>
          <Magnification>double</Magnification>
          <ExternalSampleID>string</ExternalSampleID>
          <MicroscopicDescription>string</MicroscopicDescription>
          <GrossDescription>string</GrossDescription>
          <IsAvailable>boolean</IsAvailable>
          <BlockID>string</BlockID>
          <BlockTypeID />
          <BlockTypeName>string</BlockTypeName>
          <SectioningInvestigator>
            <PrincipalInvestigatorID xsi:nil="true" />
          </SectioningInvestigator>
        </HistologyImage>
        <HistologyImage>
          <Animal>
            <Name>string</Name>
            <Sex>Male or Female or Unknown</Sex>
            <BirthDate>dateTime</BirthDate>
            <DeathDate>dateTime</DeathDate>
          </Animal>
          <AnimalAge>
            <Unit xsi:nil="true" />
            <Value>double</Value>
            <MinValue>double</MinValue>
            <MaxValue>double</MaxValue>
          </AnimalAge>
          <Experiment>
            <Name>string</Name>
            <TypeName>string</TypeName>
            <Description>string</Description>
            <Species xsi:nil="true" />
            <ModelTypeName>string</ModelTypeName>
            <AnimalAgeUnit xsi:nil="true" />
            <StatusName>string</StatusName>
            <PublicReleaseDate>dateTime</PublicReleaseDate>
            <MaleCount>int</MaleCount>
            <FemaleCount>int</FemaleCount>
            <HistologyCount>int</HistologyCount>
            <BioAssayCount>int</BioAssayCount>
            <PhenotypeDatumCount>int</PhenotypeDatumCount>
          </Experiment>
          <SampleSourceID />
          <SampleSourceName>string</SampleSourceName>
          <SampleDate>dateTime</SampleDate>
          <SlidePrepDate>dateTime</SlidePrepDate>
          <StainingProtocol>
            <Title>string</Title>
            <TypeName>string</TypeName>
            <Version>short</Version>
            <Description>string</Description>
          </StainingProtocol>
          <Magnification>double</Magnification>
          <ExternalSampleID>string</ExternalSampleID>
          <MicroscopicDescription>string</MicroscopicDescription>
          <GrossDescription>string</GrossDescription>
          <IsAvailable>boolean</IsAvailable>
          <BlockID>string</BlockID>
          <BlockTypeID />
          <BlockTypeName>string</BlockTypeName>
          <SectioningInvestigator>
            <PrincipalInvestigatorID xsi:nil="true" />
          </SectioningInvestigator>
        </HistologyImage>
      </GetHistologyImagesBySearchResult>
    </GetHistologyImagesBySearchResponse>
  </soap12:Body>
</soap12:Envelope>