POST Location/RefreshAgreements
Request Information
URI Parameters
None.
Body Parameters
RefreshAgreementsInput| Name | Description | Type | Additional information |
|---|---|---|---|
| location | Location |
None. |
|
| GrowingYear | integer |
None. |
|
| experiment | Experiment |
None. |
Request Formats
application/json, text/json
Sample:
{
"GrowingYear": 1,
"experiment": {
"$id": "1",
"ExperimentId": "e41681a6-746d-4047-a62a-2613d0c37820",
"Title": "sample string 2",
"Name": "sample string 3",
"CropId": 4,
"ExperimentTypeId": 5,
"GrowingYear": 6,
"TotalPlannedLocations": 7,
"AgreementRequired": true,
"Description": "sample string 9",
"NumberOfReplications": 1,
"AddName": "sample string 10",
"AddDate": "2025-04-04T14:39:46.5735755+00:00",
"LastMaintenanceName": "sample string 12",
"LastMaintenanceDate": "2025-04-04T14:39:46.5735755+00:00",
"IsSeedLocallySourced": true,
"IsSeedTreatmentFactor": true,
"ParentExperimentId": "8dcf4675-8d90-4456-9bd6-6e2a969dcea0",
"IsAvailableInTDE": true,
"IsLocalExperiment": true,
"ExperimentSubTypeId": 1,
"SalesSeason": 1,
"Region": "sample string 17",
"Country": "sample string 18",
"CompanyCode": "sample string 19",
"ExperimentBusinessUnitArea": [
{
"$id": "2",
"ExperimentId": "e41681a6-746d-4047-a62a-2613d0c37820",
"BusinessUnitCode": "sample string 2",
"AddName": "sample string 3",
"AddDate": "2025-04-04T14:39:46.5735755+00:00",
"DistrictCode": "sample string 5",
"Experiment": {
"$ref": "1"
},
"ChangeTracker": {
"$id": "3",
"State": 2,
"ObjectsRemovedFromCollectionProperties": {},
"OriginalValues": {},
"ExtendedProperties": {},
"ObjectsAddedToCollectionProperties": {}
}
}
],
"ExperimentFactor": [],
"ExperimentGrouping": [
{
"$id": "4",
"ExperimentId": "e41681a6-746d-4047-a62a-2613d0c37820",
"ExperimentGroupId": "5eb95a5b-dbe9-4e01-8b4e-94969b6e9ad7",
"LastMaintenanceName": "sample string 3",
"LastMaintenanceDate": "2025-04-04T14:39:46.5735755+00:00",
"Experiment": {
"$ref": "1"
},
"ExperimentGroup": {
"$id": "5",
"ExperimentGroupId": "5eb95a5b-dbe9-4e01-8b4e-94969b6e9ad7",
"GroupName": "sample string 2",
"Year": 3,
"CropId": 1,
"AddName": "sample string 5",
"AddDate": "2025-04-04T14:39:46.5735755+00:00",
"LastMaintenanceName": "sample string 7",
"LastMaintenanceDate": "2025-04-04T14:39:46.5735755+00:00",
"Crop": {
"$id": "6",
"CropId": 1,
"Name": "sample string 2",
"ProductLineCode": "sample string 3",
"Genus": "sample string 4",
"Code": "sample string 5",
"TrackingCode": "sample string 6",
"LastMaintenanceName": "sample string 7",
"LastMaintenanceDate": "2025-04-04T14:39:46.5735755+00:00",
"IsOnlySourcedLocally": true,
"ExperimentGroup": [
{
"$ref": "5"
}
],
"Experiment": [],
"ChangeTracker": {
"$id": "7",
"State": 2,
"ObjectsRemovedFromCollectionProperties": {},
"OriginalValues": {},
"ExtendedProperties": {},
"ObjectsAddedToCollectionProperties": {
"ExperimentGroup": [
{
"$ref": "5"
}
]
}
}
},
"ExperimentGrouping": [
{
"$ref": "4"
}
],
"ChangeTracker": {
"$id": "8",
"State": 2,
"ObjectsRemovedFromCollectionProperties": {},
"OriginalValues": {},
"ExtendedProperties": {},
"ObjectsAddedToCollectionProperties": {
"ExperimentGrouping": [
{
"$ref": "4"
}
]
}
}
},
"ChangeTracker": {
"$ref": "3"
}
}
],
"ExperimentLayout": [],
"ExperimentLocation": [],
"Protocol": [],
"Strip": [],
"ExperimentMeasurement": [],
"ExperimentPartnerAssignment": [],
"ChangeTracker": {
"$id": "9",
"State": 2,
"ObjectsRemovedFromCollectionProperties": {},
"OriginalValues": {},
"ExtendedProperties": {},
"ObjectsAddedToCollectionProperties": {
"ExperimentGrouping": [
{
"$ref": "4"
}
],
"ExperimentBusinessUnitArea": [
{
"$ref": "2"
}
]
}
}
}
}
application/xml, text/xml
Sample:
<LocationController.RefreshAgreementsInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.TrialsAPIServices.Controllers">
<GrowingYear>1</GrowingYear>
<experiment xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.Model" z:Id="i1" xmlns:z="http://schemas.microsoft.com/2003/10/Serialization/">
<d2p1:AddDate>2025-04-04T14:39:46.5735755+00:00</d2p1:AddDate>
<d2p1:AddName>sample string 10</d2p1:AddName>
<d2p1:AgreementRequired>true</d2p1:AgreementRequired>
<d2p1:ChangeTracker z:Id="i2">
<d2p1:ExtendedProperties />
<d2p1:ObjectsAddedToCollectionProperties>
<d2p1:AddedObjectsForProperty>
<d2p1:CollectionPropertyName>ExperimentGrouping</d2p1:CollectionPropertyName>
<d2p1:AddedObjects>
<d2p1:ObjectValue z:Id="i3" i:type="d2p1:ExperimentGrouping">
<d2p1:ChangeTracker z:Id="i4">
<d2p1:ExtendedProperties />
<d2p1:ObjectsAddedToCollectionProperties />
<d2p1:ObjectsRemovedFromCollectionProperties />
<d2p1:OriginalValues />
<d2p1:State>Added</d2p1:State>
</d2p1:ChangeTracker>
<d2p1:Experiment z:Ref="i1" />
<d2p1:ExperimentGroup z:Id="i5">
<d2p1:AddDate>2025-04-04T14:39:46.5735755+00:00</d2p1:AddDate>
<d2p1:AddName>sample string 5</d2p1:AddName>
<d2p1:ChangeTracker z:Id="i6">
<d2p1:ExtendedProperties />
<d2p1:ObjectsAddedToCollectionProperties>
<d2p1:AddedObjectsForProperty>
<d2p1:CollectionPropertyName>ExperimentGrouping</d2p1:CollectionPropertyName>
<d2p1:AddedObjects>
<d2p1:ObjectValue z:Ref="i3" />
</d2p1:AddedObjects>
</d2p1:AddedObjectsForProperty>
</d2p1:ObjectsAddedToCollectionProperties>
<d2p1:ObjectsRemovedFromCollectionProperties />
<d2p1:OriginalValues />
<d2p1:State>Added</d2p1:State>
</d2p1:ChangeTracker>
<d2p1:Crop z:Id="i7">
<d2p1:ChangeTracker z:Id="i8">
<d2p1:ExtendedProperties />
<d2p1:ObjectsAddedToCollectionProperties>
<d2p1:AddedObjectsForProperty>
<d2p1:CollectionPropertyName>ExperimentGroup</d2p1:CollectionPropertyName>
<d2p1:AddedObjects>
<d2p1:ObjectValue z:Ref="i5" />
</d2p1:AddedObjects>
</d2p1:AddedObjectsForProperty>
</d2p1:ObjectsAddedToCollectionProperties>
<d2p1:ObjectsRemovedFromCollectionProperties />
<d2p1:OriginalValues />
<d2p1:State>Added</d2p1:State>
</d2p1:ChangeTracker>
<d2p1:Code>sample string 5</d2p1:Code>
<d2p1:CropId>1</d2p1:CropId>
<d2p1:Experiment />
<d2p1:ExperimentGroup>
<d2p1:ExperimentGroup z:Ref="i5" />
</d2p1:ExperimentGroup>
<d2p1:Genus>sample string 4</d2p1:Genus>
<d2p1:IsOnlySourcedLocally>true</d2p1:IsOnlySourcedLocally>
<d2p1:LastMaintenanceDate>2025-04-04T14:39:46.5735755+00:00</d2p1:LastMaintenanceDate>
<d2p1:LastMaintenanceName>sample string 7</d2p1:LastMaintenanceName>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:ProductLineCode>sample string 3</d2p1:ProductLineCode>
<d2p1:TrackingCode>sample string 6</d2p1:TrackingCode>
</d2p1:Crop>
<d2p1:CropId>1</d2p1:CropId>
<d2p1:ExperimentGroupId>5eb95a5b-dbe9-4e01-8b4e-94969b6e9ad7</d2p1:ExperimentGroupId>
<d2p1:ExperimentGrouping>
<d2p1:ExperimentGrouping z:Ref="i3" />
</d2p1:ExperimentGrouping>
<d2p1:GroupName>sample string 2</d2p1:GroupName>
<d2p1:LastMaintenanceDate>2025-04-04T14:39:46.5735755+00:00</d2p1:LastMaintenanceDate>
<d2p1:LastMaintenanceName>sample string 7</d2p1:LastMaintenanceName>
<d2p1:Year>3</d2p1:Year>
</d2p1:ExperimentGroup>
<d2p1:ExperimentGroupId>5eb95a5b-dbe9-4e01-8b4e-94969b6e9ad7</d2p1:ExperimentGroupId>
<d2p1:ExperimentId>e41681a6-746d-4047-a62a-2613d0c37820</d2p1:ExperimentId>
<d2p1:LastMaintenanceDate>2025-04-04T14:39:46.5735755+00:00</d2p1:LastMaintenanceDate>
<d2p1:LastMaintenanceName>sample string 3</d2p1:LastMaintenanceName>
</d2p1:ObjectValue>
</d2p1:AddedObjects>
</d2p1:AddedObjectsForProperty>
<d2p1:AddedObjectsForProperty>
<d2p1:CollectionPropertyName>ExperimentBusinessUnitArea</d2p1:CollectionPropertyName>
<d2p1:AddedObjects>
<d2p1:ObjectValue z:Id="i9" i:type="d2p1:ExperimentBusinessUnitArea">
<d2p1:AddDate>2025-04-04T14:39:46.5735755+00:00</d2p1:AddDate>
<d2p1:AddName>sample string 3</d2p1:AddName>
<d2p1:BusinessUnit i:nil="true" />
<d2p1:BusinessUnitCode>sample string 2</d2p1:BusinessUnitCode>
<d2p1:ChangeTracker z:Ref="i4" />
<d2p1:DistrictCode>sample string 5</d2p1:DistrictCode>
<d2p1:Experiment z:Ref="i1" />
<d2p1:ExperimentId>e41681a6-746d-4047-a62a-2613d0c37820</d2p1:ExperimentId>
</d2p1:ObjectValue>
</d2p1:AddedObjects>
</d2p1:AddedObjectsForProperty>
</d2p1:ObjectsAddedToCollectionProperties>
<d2p1:ObjectsRemovedFromCollectionProperties />
<d2p1:OriginalValues />
<d2p1:State>Added</d2p1:State>
</d2p1:ChangeTracker>
<d2p1:CompanyCode>sample string 19</d2p1:CompanyCode>
<d2p1:Country>sample string 18</d2p1:Country>
<d2p1:Crop i:nil="true" />
<d2p1:CropId>4</d2p1:CropId>
<d2p1:Description>sample string 9</d2p1:Description>
<d2p1:ExperimentBusinessUnitArea>
<d2p1:ExperimentBusinessUnitArea z:Ref="i9" />
</d2p1:ExperimentBusinessUnitArea>
<d2p1:ExperimentFactor />
<d2p1:ExperimentGrouping>
<d2p1:ExperimentGrouping z:Ref="i3" />
</d2p1:ExperimentGrouping>
<d2p1:ExperimentId>e41681a6-746d-4047-a62a-2613d0c37820</d2p1:ExperimentId>
<d2p1:ExperimentLayout />
<d2p1:ExperimentLocation />
<d2p1:ExperimentMeasurement />
<d2p1:ExperimentPartnerAssignment />
<d2p1:ExperimentSubTypeId>1</d2p1:ExperimentSubTypeId>
<d2p1:ExperimentType i:nil="true" />
<d2p1:ExperimentTypeId>5</d2p1:ExperimentTypeId>
<d2p1:GrowingYear>6</d2p1:GrowingYear>
<d2p1:IsAvailableInTDE>true</d2p1:IsAvailableInTDE>
<d2p1:IsLocalExperiment>true</d2p1:IsLocalExperiment>
<d2p1:IsSeedLocallySourced>true</d2p1:IsSeedLocallySourced>
<d2p1:IsSeedTreatmentFactor>true</d2p1:IsSeedTreatmentFactor>
<d2p1:LastMaintenanceDate>2025-04-04T14:39:46.5735755+00:00</d2p1:LastMaintenanceDate>
<d2p1:LastMaintenanceName>sample string 12</d2p1:LastMaintenanceName>
<d2p1:Name>sample string 3</d2p1:Name>
<d2p1:NumberOfReplications>1</d2p1:NumberOfReplications>
<d2p1:ParentExperimentId>8dcf4675-8d90-4456-9bd6-6e2a969dcea0</d2p1:ParentExperimentId>
<d2p1:Protocol />
<d2p1:Region>sample string 17</d2p1:Region>
<d2p1:SalesSeason>1</d2p1:SalesSeason>
<d2p1:Strip />
<d2p1:Title>sample string 2</d2p1:Title>
<d2p1:TotalPlannedLocations>7</d2p1:TotalPlannedLocations>
</experiment>
<location xmlns:d2p1="http://schemas.datacontract.org/2004/07/Pioneer.Trials.Domain.Model" i:nil="true" />
</LocationController.RefreshAgreementsInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
LocationWithAgreements| Name | Description | Type | Additional information |
|---|---|---|---|
| location | Location |
None. |
|
| agreements | Collection of LocationAgreement |
None. |
Response Formats
application/json, text/json
Sample:
Sample not available.