POST Protocol/GetByExperimentIdForDisplay/{experimentId}

Request Information

URI Parameters

Name	Description	Type	Additional information
experimentId		globally unique identifier	Required

Body Parameters

None.

Response Information

Resource Description

Collection of Protocol

Name	Type	Additional information
ProtocolId	globally unique identifier	None.
ExperimentId	globally unique identifier	None.
Name	string	None.
Subtitle	string	None.
LastMaintenanceName	string	None.
LastMaintenanceDate	date	None.
IsUploaded	boolean	None.
IsTDEProtocol	boolean	None.
Experiment	Experiment	None.
ProtocolVersion	Collection of ProtocolVersion	None.
ChangeTracker	ObjectChangeTracker	None.

Response Formats

application/json, text/json

Sample:

[
  null,
  {
    "$id": "1",
    "ProtocolId": "1ebe71f0-4ea8-4aec-8540-77b762186b64",
    "ExperimentId": "37517e72-29a1-4846-9634-ee781387ecd7",
    "Name": "sample string 8",
    "Subtitle": "sample string 9",
    "LastMaintenanceName": "sample string 10",
    "LastMaintenanceDate": "2024-12-05T21:08:18.0842872+00:00",
    "IsUploaded": true,
    "IsTDEProtocol": true,
    "ProtocolVersion": [
      {
        "$id": "2",
        "ProtocolId": "1ebe71f0-4ea8-4aec-8540-77b762186b64",
        "Version": 2,
        "FileName": "sample string 3",
        "Document": "QEA=",
        "LastMaintenanceName": "sample string 4",
        "LastMaintenanceDate": "2024-12-05T21:08:18.1920268+00:00",
        "Protocol": {
          "$ref": "1"
        },
        "ChangeTracker": {
          "$id": "3",
          "State": 2,
          "ObjectsRemovedFromCollectionProperties": {},
          "OriginalValues": {},
          "ExtendedProperties": {},
          "ObjectsAddedToCollectionProperties": {}
        }
      }
    ],
    "ChangeTracker": {
      "$id": "4",
      "State": 2,
      "ObjectsRemovedFromCollectionProperties": {},
      "OriginalValues": {},
      "ExtendedProperties": {},
      "ObjectsAddedToCollectionProperties": {
        "ProtocolVersion": [
          {
            "$ref": "2"
          }
        ]
      }
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfProtocol xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.Model">
  <Protocol i:nil="true" />
  <Protocol z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
    <ChangeTracker z:Id="i2">
      <ExtendedProperties />
      <ObjectsAddedToCollectionProperties>
        <AddedObjectsForProperty>
          <CollectionPropertyName>ProtocolVersion</CollectionPropertyName>
          <AddedObjects>
            <ObjectValue z:Id="i3" i:type="ProtocolVersion">
              <ChangeTracker z:Id="i4">
                <ExtendedProperties />
                <ObjectsAddedToCollectionProperties />
                <ObjectsRemovedFromCollectionProperties />
                <OriginalValues />
                <State>Added</State>
              </ChangeTracker>
              <Document>QEA=</Document>
              <FileName>sample string 3</FileName>
              <LastMaintenanceDate>2024-12-05T21:08:18.1920268+00:00</LastMaintenanceDate>
              <LastMaintenanceName>sample string 4</LastMaintenanceName>
              <Protocol z:Ref="i1" />
              <ProtocolId>1ebe71f0-4ea8-4aec-8540-77b762186b64</ProtocolId>
              <Version>2</Version>
            </ObjectValue>
          </AddedObjects>
        </AddedObjectsForProperty>
      </ObjectsAddedToCollectionProperties>
      <ObjectsRemovedFromCollectionProperties />
      <OriginalValues />
      <State>Added</State>
    </ChangeTracker>
    <Experiment i:nil="true" />
    <ExperimentId>37517e72-29a1-4846-9634-ee781387ecd7</ExperimentId>
    <IsTDEProtocol>true</IsTDEProtocol>
    <IsUploaded>true</IsUploaded>
    <LastMaintenanceDate>2024-12-05T21:08:18.0842872+00:00</LastMaintenanceDate>
    <LastMaintenanceName>sample string 10</LastMaintenanceName>
    <Name>sample string 8</Name>
    <ProtocolId>1ebe71f0-4ea8-4aec-8540-77b762186b64</ProtocolId>
    <ProtocolVersion>
      <ProtocolVersion z:Ref="i3" />
    </ProtocolVersion>
    <Subtitle>sample string 9</Subtitle>
  </Protocol>
</ArrayOfProtocol>