ExperimentWebService


Click here for a complete list of operations.

GetExperiment

This method will return an Experiment for the specified matching ExperimentID

Test

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

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/GetExperiment"

<?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>
    <GetExperiment xmlns="http://www.diacomp.org/webservices/">
      <ExperimentID>int</ExperimentID>
    </GetExperiment>
  </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>
    <GetExperimentResponse xmlns="http://www.diacomp.org/webservices/">
      <GetExperimentResult>
        <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 />
          <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>
            <Description>string</Description>
            <ImageName>string</ImageName>
            <Active>boolean</Active>
            <Comment>string</Comment>
            <History xsi:nil="true" />
          </CurationFlag>
          <CurationFlag>
            <Description>string</Description>
            <ImageName>string</ImageName>
            <Active>boolean</Active>
            <Comment>string</Comment>
            <History xsi:nil="true" />
          </CurationFlag>
        </Flags>
        <Documents>
          <Document>
            <Title>string</Title>
            <DocTypeName>string</DocTypeName>
            <Data>base64Binary</Data>
            <Year>int</Year>
          </Document>
          <Document>
            <Title>string</Title>
            <DocTypeName>string</DocTypeName>
            <Data>base64Binary</Data>
            <Year>int</Year>
          </Document>
        </Documents>
        <CurationStatusID />
        <DataCollected>boolean</DataCollected>
        <ConsortiumID />
      </GetExperimentResult>
    </GetExperimentResponse>
  </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>
    <GetExperiment xmlns="http://www.diacomp.org/webservices/">
      <ExperimentID>int</ExperimentID>
    </GetExperiment>
  </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>
    <GetExperimentResponse xmlns="http://www.diacomp.org/webservices/">
      <GetExperimentResult>
        <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 />
          <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>
            <Description>string</Description>
            <ImageName>string</ImageName>
            <Active>boolean</Active>
            <Comment>string</Comment>
            <History xsi:nil="true" />
          </CurationFlag>
          <CurationFlag>
            <Description>string</Description>
            <ImageName>string</ImageName>
            <Active>boolean</Active>
            <Comment>string</Comment>
            <History xsi:nil="true" />
          </CurationFlag>
        </Flags>
        <Documents>
          <Document>
            <Title>string</Title>
            <DocTypeName>string</DocTypeName>
            <Data>base64Binary</Data>
            <Year>int</Year>
          </Document>
          <Document>
            <Title>string</Title>
            <DocTypeName>string</DocTypeName>
            <Data>base64Binary</Data>
            <Year>int</Year>
          </Document>
        </Documents>
        <CurationStatusID />
        <DataCollected>boolean</DataCollected>
        <ConsortiumID />
      </GetExperimentResult>
    </GetExperimentResponse>
  </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 /webservices/ExperimentWebService.asmx/GetExperiment?ExperimentID=string HTTP/1.1
Host: www.diacomp.org
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<Experiment xmlns="http://www.diacomp.org/webservices/">
  <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 />
    <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>
      <Description>string</Description>
      <ImageName>string</ImageName>
      <Active>boolean</Active>
      <Comment>string</Comment>
      <History>
        <CreationID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LastModifyID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreationDate>dateTime</CreationDate>
        <LastModifyDate>dateTime</LastModifyDate>
      </History>
    </CurationFlag>
    <CurationFlag>
      <Description>string</Description>
      <ImageName>string</ImageName>
      <Active>boolean</Active>
      <Comment>string</Comment>
      <History>
        <CreationID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LastModifyID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreationDate>dateTime</CreationDate>
        <LastModifyDate>dateTime</LastModifyDate>
      </History>
    </CurationFlag>
  </Flags>
  <Documents>
    <Document>
      <Title>string</Title>
      <DocTypeName>string</DocTypeName>
      <Data>base64Binary</Data>
      <Year>int</Year>
    </Document>
    <Document>
      <Title>string</Title>
      <DocTypeName>string</DocTypeName>
      <Data>base64Binary</Data>
      <Year>int</Year>
    </Document>
  </Documents>
  <CurationStatusID />
  <DataCollected>boolean</DataCollected>
  <ConsortiumID />
</Experiment>

HTTP POST

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

POST /webservices/ExperimentWebService.asmx/GetExperiment HTTP/1.1
Host: www.diacomp.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<Experiment xmlns="http://www.diacomp.org/webservices/">
  <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 />
    <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>
      <Description>string</Description>
      <ImageName>string</ImageName>
      <Active>boolean</Active>
      <Comment>string</Comment>
      <History>
        <CreationID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LastModifyID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreationDate>dateTime</CreationDate>
        <LastModifyDate>dateTime</LastModifyDate>
      </History>
    </CurationFlag>
    <CurationFlag>
      <Description>string</Description>
      <ImageName>string</ImageName>
      <Active>boolean</Active>
      <Comment>string</Comment>
      <History>
        <CreationID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <LastModifyID d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
        <CreationDate>dateTime</CreationDate>
        <LastModifyDate>dateTime</LastModifyDate>
      </History>
    </CurationFlag>
  </Flags>
  <Documents>
    <Document>
      <Title>string</Title>
      <DocTypeName>string</DocTypeName>
      <Data>base64Binary</Data>
      <Year>int</Year>
    </Document>
    <Document>
      <Title>string</Title>
      <DocTypeName>string</DocTypeName>
      <Data>base64Binary</Data>
      <Year>int</Year>
    </Document>
  </Documents>
  <CurationStatusID />
  <DataCollected>boolean</DataCollected>
  <ConsortiumID />
</Experiment>