ExperimentWebService


Click here for a complete list of operations.

GetExperimentsByModelType

This method will return a list of experiments ordered by Model Type

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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

<?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>
    <GetExperimentsByModelType xmlns="http://www.diacomp.org/webservices/" />
  </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>
    <GetExperimentsByModelTypeResponse xmlns="http://www.diacomp.org/webservices/">
      <GetExperimentsByModelTypeResult>
        <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>
      </GetExperimentsByModelTypeResult>
    </GetExperimentsByModelTypeResponse>
  </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>
    <GetExperimentsByModelType xmlns="http://www.diacomp.org/webservices/" />
  </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>
    <GetExperimentsByModelTypeResponse xmlns="http://www.diacomp.org/webservices/">
      <GetExperimentsByModelTypeResult>
        <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>
      </GetExperimentsByModelTypeResult>
    </GetExperimentsByModelTypeResponse>
  </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/GetExperimentsByModelType? 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"?>
<ArrayOfExperiment xmlns="http://www.diacomp.org/webservices/">
  <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 />
      <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CurationFlag>
      <CurationFlag>
        <Description>string</Description>
        <ImageName>string</ImageName>
        <Active>boolean</Active>
        <Comment>string</Comment>
        <History d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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>
  <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 />
      <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CurationFlag>
      <CurationFlag>
        <Description>string</Description>
        <ImageName>string</ImageName>
        <Active>boolean</Active>
        <Comment>string</Comment>
        <History d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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>
</ArrayOfExperiment>

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/GetExperimentsByModelType HTTP/1.1
Host: www.diacomp.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfExperiment xmlns="http://www.diacomp.org/webservices/">
  <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 />
      <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CurationFlag>
      <CurationFlag>
        <Description>string</Description>
        <ImageName>string</ImageName>
        <Active>boolean</Active>
        <Comment>string</Comment>
        <History d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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>
  <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 />
      <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 d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </CurationFlag>
      <CurationFlag>
        <Description>string</Description>
        <ImageName>string</ImageName>
        <Active>boolean</Active>
        <Comment>string</Comment>
        <History d5p1:nil="true" xmlns:d5p1="http://www.w3.org/2001/XMLSchema-instance" />
      </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>
</ArrayOfExperiment>