ExperimentWebService


Click here for a complete list of operations.

GetExperimentsBySearch

This method will return a list of Experiments that meet the optional Experiment 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/ExperimentWebService.asmx HTTP/1.1
Host: www.diacomp.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://www.diacomp.org/webservices/GetExperimentsBySearch"

<?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>
    <GetExperimentsBySearch xmlns="http://www.diacomp.org/webservices/">
      <experimentSearch>
        <InvestigatorID />
        <CenterID />
        <ExperimentTypeID />
        <ExperimentID />
        <ExperimentStatusID />
        <SubContractID />
        <OrderID />
        <SpeciesID />
        <IsNIDDKAZ>boolean</IsNIDDKAZ>
        <PhenotypeAssayID />
        <CatalogGroupID />
        <TissueID />
        <StrainID />
        <BackgroundStrainID />
        <ResearchAreaID />
        <PublicationID />
        <IsPublic>boolean</IsPublic>
        <FlagIDs>string</FlagIDs>
        <NoFlags>boolean</NoFlags>
        <BitwiseDisjunctive>boolean</BitwiseDisjunctive>
        <RowCount>int</RowCount>
        <OrderBy>unsignedByte</OrderBy>
        <CreatedFromDate>dateTime</CreatedFromDate>
        <CreatedToDate>dateTime</CreatedToDate>
        <TriStateActive>short</TriStateActive>
        <ExcludeAlumni>boolean</ExcludeAlumni>
        <ExcludeUnreleasable>boolean</ExcludeUnreleasable>
      </experimentSearch>
    </GetExperimentsBySearch>
  </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>
    <GetExperimentsBySearchResponse xmlns="http://www.diacomp.org/webservices/">
      <GetExperimentsBySearchResult>
        <Experiment>
          <Name>string</Name>
          <Center>
            <CenterID>string</CenterID>
            <Name>string</Name>
            <ShortName>string</ShortName>
            <Url>string</Url>
            <GrantNumber>string</GrantNumber>
            <TestNumberPrefix>string</TestNumberPrefix>
            <Director>string</Director>
            <DirectorEmail>string</DirectorEmail>
            <Description>string</Description>
            <CenterRRID>string</CenterRRID>
            <IsAlumni>boolean</IsAlumni>
          </Center>
          <TypeName>string</TypeName>
          <Description>string</Description>
          <Species>
            <Name>string</Name>
          </Species>
          <ModelTypeName>string</ModelTypeName>
          <AnimalAgeUnit>
            <TypeID xsi:nil="true" />
            <TypeName>string</TypeName>
            <Name>string</Name>
            <Symbol>string</Symbol>
          </AnimalAgeUnit>
          <StatusName>string</StatusName>
          <HasData>boolean</HasData>
          <PublicReleaseDate>dateTime</PublicReleaseDate>
          <MaleCount>int</MaleCount>
          <FemaleCount>int</FemaleCount>
          <HistologyCount>int</HistologyCount>
          <BioAssayCount>int</BioAssayCount>
          <PhenotypeDatumCount>int</PhenotypeDatumCount>
          <DocumentDataCount>int</DocumentDataCount>
          <Flags>
            <CurationFlag xsi:nil="true" />
            <CurationFlag xsi:nil="true" />
          </Flags>
          <Documents>
            <Document xsi:nil="true" />
            <Document xsi:nil="true" />
          </Documents>
          <CurationStatusID />
          <DataCollected>boolean</DataCollected>
          <ConsortiumID />
        </Experiment>
        <Experiment>
          <Name>string</Name>
          <Center>
            <CenterID>string</CenterID>
            <Name>string</Name>
            <ShortName>string</ShortName>
            <Url>string</Url>
            <GrantNumber>string</GrantNumber>
            <TestNumberPrefix>string</TestNumberPrefix>
            <Director>string</Director>
            <DirectorEmail>string</DirectorEmail>
            <Description>string</Description>
            <CenterRRID>string</CenterRRID>
            <IsAlumni>boolean</IsAlumni>
          </Center>
          <TypeName>string</TypeName>
          <Description>string</Description>
          <Species>
            <Name>string</Name>
          </Species>
          <ModelTypeName>string</ModelTypeName>
          <AnimalAgeUnit>
            <TypeID xsi:nil="true" />
            <TypeName>string</TypeName>
            <Name>string</Name>
            <Symbol>string</Symbol>
          </AnimalAgeUnit>
          <StatusName>string</StatusName>
          <HasData>boolean</HasData>
          <PublicReleaseDate>dateTime</PublicReleaseDate>
          <MaleCount>int</MaleCount>
          <FemaleCount>int</FemaleCount>
          <HistologyCount>int</HistologyCount>
          <BioAssayCount>int</BioAssayCount>
          <PhenotypeDatumCount>int</PhenotypeDatumCount>
          <DocumentDataCount>int</DocumentDataCount>
          <Flags>
            <CurationFlag xsi:nil="true" />
            <CurationFlag xsi:nil="true" />
          </Flags>
          <Documents>
            <Document xsi:nil="true" />
            <Document xsi:nil="true" />
          </Documents>
          <CurationStatusID />
          <DataCollected>boolean</DataCollected>
          <ConsortiumID />
        </Experiment>
      </GetExperimentsBySearchResult>
    </GetExperimentsBySearchResponse>
  </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/ExperimentWebService.asmx HTTP/1.1
Host: www.diacomp.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>
    <GetExperimentsBySearch xmlns="http://www.diacomp.org/webservices/">
      <experimentSearch>
        <InvestigatorID />
        <CenterID />
        <ExperimentTypeID />
        <ExperimentID />
        <ExperimentStatusID />
        <SubContractID />
        <OrderID />
        <SpeciesID />
        <IsNIDDKAZ>boolean</IsNIDDKAZ>
        <PhenotypeAssayID />
        <CatalogGroupID />
        <TissueID />
        <StrainID />
        <BackgroundStrainID />
        <ResearchAreaID />
        <PublicationID />
        <IsPublic>boolean</IsPublic>
        <FlagIDs>string</FlagIDs>
        <NoFlags>boolean</NoFlags>
        <BitwiseDisjunctive>boolean</BitwiseDisjunctive>
        <RowCount>int</RowCount>
        <OrderBy>unsignedByte</OrderBy>
        <CreatedFromDate>dateTime</CreatedFromDate>
        <CreatedToDate>dateTime</CreatedToDate>
        <TriStateActive>short</TriStateActive>
        <ExcludeAlumni>boolean</ExcludeAlumni>
        <ExcludeUnreleasable>boolean</ExcludeUnreleasable>
      </experimentSearch>
    </GetExperimentsBySearch>
  </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>
    <GetExperimentsBySearchResponse xmlns="http://www.diacomp.org/webservices/">
      <GetExperimentsBySearchResult>
        <Experiment>
          <Name>string</Name>
          <Center>
            <CenterID>string</CenterID>
            <Name>string</Name>
            <ShortName>string</ShortName>
            <Url>string</Url>
            <GrantNumber>string</GrantNumber>
            <TestNumberPrefix>string</TestNumberPrefix>
            <Director>string</Director>
            <DirectorEmail>string</DirectorEmail>
            <Description>string</Description>
            <CenterRRID>string</CenterRRID>
            <IsAlumni>boolean</IsAlumni>
          </Center>
          <TypeName>string</TypeName>
          <Description>string</Description>
          <Species>
            <Name>string</Name>
          </Species>
          <ModelTypeName>string</ModelTypeName>
          <AnimalAgeUnit>
            <TypeID xsi:nil="true" />
            <TypeName>string</TypeName>
            <Name>string</Name>
            <Symbol>string</Symbol>
          </AnimalAgeUnit>
          <StatusName>string</StatusName>
          <HasData>boolean</HasData>
          <PublicReleaseDate>dateTime</PublicReleaseDate>
          <MaleCount>int</MaleCount>
          <FemaleCount>int</FemaleCount>
          <HistologyCount>int</HistologyCount>
          <BioAssayCount>int</BioAssayCount>
          <PhenotypeDatumCount>int</PhenotypeDatumCount>
          <DocumentDataCount>int</DocumentDataCount>
          <Flags>
            <CurationFlag xsi:nil="true" />
            <CurationFlag xsi:nil="true" />
          </Flags>
          <Documents>
            <Document xsi:nil="true" />
            <Document xsi:nil="true" />
          </Documents>
          <CurationStatusID />
          <DataCollected>boolean</DataCollected>
          <ConsortiumID />
        </Experiment>
        <Experiment>
          <Name>string</Name>
          <Center>
            <CenterID>string</CenterID>
            <Name>string</Name>
            <ShortName>string</ShortName>
            <Url>string</Url>
            <GrantNumber>string</GrantNumber>
            <TestNumberPrefix>string</TestNumberPrefix>
            <Director>string</Director>
            <DirectorEmail>string</DirectorEmail>
            <Description>string</Description>
            <CenterRRID>string</CenterRRID>
            <IsAlumni>boolean</IsAlumni>
          </Center>
          <TypeName>string</TypeName>
          <Description>string</Description>
          <Species>
            <Name>string</Name>
          </Species>
          <ModelTypeName>string</ModelTypeName>
          <AnimalAgeUnit>
            <TypeID xsi:nil="true" />
            <TypeName>string</TypeName>
            <Name>string</Name>
            <Symbol>string</Symbol>
          </AnimalAgeUnit>
          <StatusName>string</StatusName>
          <HasData>boolean</HasData>
          <PublicReleaseDate>dateTime</PublicReleaseDate>
          <MaleCount>int</MaleCount>
          <FemaleCount>int</FemaleCount>
          <HistologyCount>int</HistologyCount>
          <BioAssayCount>int</BioAssayCount>
          <PhenotypeDatumCount>int</PhenotypeDatumCount>
          <DocumentDataCount>int</DocumentDataCount>
          <Flags>
            <CurationFlag xsi:nil="true" />
            <CurationFlag xsi:nil="true" />
          </Flags>
          <Documents>
            <Document xsi:nil="true" />
            <Document xsi:nil="true" />
          </Documents>
          <CurationStatusID />
          <DataCollected>boolean</DataCollected>
          <ConsortiumID />
        </Experiment>
      </GetExperimentsBySearchResult>
    </GetExperimentsBySearchResponse>
  </soap12:Body>
</soap12:Envelope>