PUT api/SampleSubmissions

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SubmissionKey	string	Required
SubmissionDate	date	Required
UserKey	string	Required
UserName	string	None.
FacilityCode	string	Required String length: inclusive between 0 and 50
ClientID	string	Required String length: inclusive between 0 and 50
ClientName	string	String length: inclusive between 0 and 50
ProjectKey	string	Required String length: inclusive between 0 and 50
ProjectName	string	None.
WorkOrder	string	String length: inclusive between 0 and 50
SubmissionComments	string	String length: inclusive between 0 and 255
Status	SampleSumissionStatus	Required
StatusByKey	string	Required String length: inclusive between 0 and 50
StatusByName	string	None.
StatusDate	date	None.
ProjectNumber	string	None.
COCNum	string	None.
BOLNum	string	None.
Shipper	string	None.
PONumber	string	None.
SDGID	string	None.
TAT	integer	None.
Due	date	None.
ProjBillCode	string	None.
Samples	Collection of SampleRequestUpdate	None.
Coolers	Collection of SampleSubmissionCoolerRequest	None.
SpecialInfos	Collection of SpecialInfoRequest	None.

Request Formats

application/json, text/json

Sample:

{
  "Status": 1,
  "SubmissionKey": "sample string 1",
  "SubmissionDate": "2026-05-12T08:36:42.1262521-04:00",
  "UserKey": "sample string 3",
  "UserName": "sample string 4",
  "FacilityCode": "sample string 5",
  "ClientID": "sample string 6",
  "ClientName": "sample string 7",
  "ProjectKey": "sample string 8",
  "ProjectName": "sample string 9",
  "WorkOrder": "sample string 10",
  "SubmissionComments": "sample string 11",
  "StatusByKey": "sample string 12",
  "StatusByName": "sample string 13",
  "StatusDate": "2026-05-12T08:36:42.1262521-04:00",
  "ProjectNumber": "sample string 14",
  "COCNum": "sample string 15",
  "BOLNum": "sample string 16",
  "Shipper": "sample string 17",
  "PONumber": "sample string 18",
  "SDGID": "sample string 19",
  "TAT": 1,
  "Due": "2026-05-12T08:36:42.1262521-04:00",
  "ProjBillCode": "sample string 20",
  "Samples": [
    {
      "Sample": "sample string 1",
      "SampleName": "sample string 2",
      "SampleAlias": "sample string 3",
      "SampleRegID": "sample string 4",
      "SampleType": "sample string 5",
      "MatrixKey": "sample string 6",
      "MatrixName": "sample string 7",
      "ClientMatrixName": "sample string 8",
      "Sampled": "2026-05-12T08:36:42.1262521-04:00",
      "SampledBegin": "2026-05-12T08:36:42.1262521-04:00",
      "SampledBy": "sample string 9",
      "TimeZoneKey": 1,
      "TimeZoneName": "sample string 10",
      "SampleComments": "sample string 11",
      "BegDepth": 1.1,
      "EndDepth": 1.1,
      "DepthUnits": "sample string 12",
      "Latitude": "sample string 13",
      "Longitude": "sample string 14",
      "Gradient": "sample string 15",
      "CasingHeight": "sample string 16",
      "CasingDiameter": "sample string 17",
      "CasingType": "sample string 18",
      "WellDepth": "sample string 19",
      "Elevation": "sample string 20",
      "Containers": [
        {
          "Designator": "sample string 1",
          "SxContainerKey": "sample string 2",
          "SxContainerName": "sample string 3",
          "Cooler": "sample string 4",
          "Comments": "sample string 5",
          "ContLotNum": "sample string 6",
          "Amount": 1.1,
          "SpecialInfos": [
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            },
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            }
          ]
        },
        {
          "Designator": "sample string 1",
          "SxContainerKey": "sample string 2",
          "SxContainerName": "sample string 3",
          "Cooler": "sample string 4",
          "Comments": "sample string 5",
          "ContLotNum": "sample string 6",
          "Amount": 1.1,
          "SpecialInfos": [
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            },
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            }
          ]
        }
      ],
      "isNotCollected": true,
      "Analyses": [
        {
          "AnalysisKey": "sample string 1",
          "AnalysisName": "sample string 2",
          "VersionID": "sample string 3",
          "TAT": 1,
          "Due": "2026-05-12T08:36:42.1262521-04:00",
          "LogComments": "sample string 4",
          "Price": 1.1,
          "Surcharge": 1.1
        },
        {
          "AnalysisKey": "sample string 1",
          "AnalysisName": "sample string 2",
          "VersionID": "sample string 3",
          "TAT": 1,
          "Due": "2026-05-12T08:36:42.1262521-04:00",
          "LogComments": "sample string 4",
          "Price": 1.1,
          "Surcharge": 1.1
        }
      ],
      "SpecialInfos": [
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        },
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        }
      ]
    },
    {
      "Sample": "sample string 1",
      "SampleName": "sample string 2",
      "SampleAlias": "sample string 3",
      "SampleRegID": "sample string 4",
      "SampleType": "sample string 5",
      "MatrixKey": "sample string 6",
      "MatrixName": "sample string 7",
      "ClientMatrixName": "sample string 8",
      "Sampled": "2026-05-12T08:36:42.1262521-04:00",
      "SampledBegin": "2026-05-12T08:36:42.1262521-04:00",
      "SampledBy": "sample string 9",
      "TimeZoneKey": 1,
      "TimeZoneName": "sample string 10",
      "SampleComments": "sample string 11",
      "BegDepth": 1.1,
      "EndDepth": 1.1,
      "DepthUnits": "sample string 12",
      "Latitude": "sample string 13",
      "Longitude": "sample string 14",
      "Gradient": "sample string 15",
      "CasingHeight": "sample string 16",
      "CasingDiameter": "sample string 17",
      "CasingType": "sample string 18",
      "WellDepth": "sample string 19",
      "Elevation": "sample string 20",
      "Containers": [
        {
          "Designator": "sample string 1",
          "SxContainerKey": "sample string 2",
          "SxContainerName": "sample string 3",
          "Cooler": "sample string 4",
          "Comments": "sample string 5",
          "ContLotNum": "sample string 6",
          "Amount": 1.1,
          "SpecialInfos": [
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            },
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            }
          ]
        },
        {
          "Designator": "sample string 1",
          "SxContainerKey": "sample string 2",
          "SxContainerName": "sample string 3",
          "Cooler": "sample string 4",
          "Comments": "sample string 5",
          "ContLotNum": "sample string 6",
          "Amount": 1.1,
          "SpecialInfos": [
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            },
            {
              "DisplayName": "sample string 1",
              "Answer": "sample string 2"
            }
          ]
        }
      ],
      "isNotCollected": true,
      "Analyses": [
        {
          "AnalysisKey": "sample string 1",
          "AnalysisName": "sample string 2",
          "VersionID": "sample string 3",
          "TAT": 1,
          "Due": "2026-05-12T08:36:42.1262521-04:00",
          "LogComments": "sample string 4",
          "Price": 1.1,
          "Surcharge": 1.1
        },
        {
          "AnalysisKey": "sample string 1",
          "AnalysisName": "sample string 2",
          "VersionID": "sample string 3",
          "TAT": 1,
          "Due": "2026-05-12T08:36:42.1262521-04:00",
          "LogComments": "sample string 4",
          "Price": 1.1,
          "Surcharge": 1.1
        }
      ],
      "SpecialInfos": [
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        },
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        }
      ]
    }
  ],
  "Coolers": [
    {
      "Cooler": "sample string 1",
      "Description": "sample string 2",
      "Comments": "sample string 3",
      "TempC": 1.1,
      "SpecialInfos": [
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        },
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        }
      ]
    },
    {
      "Cooler": "sample string 1",
      "Description": "sample string 2",
      "Comments": "sample string 3",
      "TempC": 1.1,
      "SpecialInfos": [
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        },
        {
          "DisplayName": "sample string 1",
          "Answer": "sample string 2"
        }
      ]
    }
  ],
  "SpecialInfos": [
    {
      "DisplayName": "sample string 1",
      "Answer": "sample string 2"
    },
    {
      "DisplayName": "sample string 1",
      "Answer": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<SampleSubmissionUpdate xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Promium.ClientConnectAPI">
  <BOLNum>sample string 16</BOLNum>
  <COCNum>sample string 15</COCNum>
  <ClientID>sample string 6</ClientID>
  <ClientName>sample string 7</ClientName>
  <Coolers>
    <SampleSubmissionCoolerRequest>
      <Comments>sample string 3</Comments>
      <Cooler>sample string 1</Cooler>
      <Description>sample string 2</Description>
      <SpecialInfos>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
      </SpecialInfos>
      <TempC>1.1</TempC>
    </SampleSubmissionCoolerRequest>
    <SampleSubmissionCoolerRequest>
      <Comments>sample string 3</Comments>
      <Cooler>sample string 1</Cooler>
      <Description>sample string 2</Description>
      <SpecialInfos>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
      </SpecialInfos>
      <TempC>1.1</TempC>
    </SampleSubmissionCoolerRequest>
  </Coolers>
  <Due>2026-05-12T08:36:42.1262521-04:00</Due>
  <FacilityCode>sample string 5</FacilityCode>
  <PONumber>sample string 18</PONumber>
  <ProjBillCode>sample string 20</ProjBillCode>
  <ProjectKey>sample string 8</ProjectKey>
  <ProjectName>sample string 9</ProjectName>
  <ProjectNumber>sample string 14</ProjectNumber>
  <SDGID>sample string 19</SDGID>
  <Samples>
    <SampleRequestUpdate>
      <Analyses>
        <SampleSubmissionAnalysisRequest>
          <AnalysisKey>sample string 1</AnalysisKey>
          <AnalysisName>sample string 2</AnalysisName>
          <Due>2026-05-12T08:36:42.1262521-04:00</Due>
          <LogComments>sample string 4</LogComments>
          <Price>1.1</Price>
          <Surcharge>1.1</Surcharge>
          <TAT>1</TAT>
          <VersionID>sample string 3</VersionID>
        </SampleSubmissionAnalysisRequest>
        <SampleSubmissionAnalysisRequest>
          <AnalysisKey>sample string 1</AnalysisKey>
          <AnalysisName>sample string 2</AnalysisName>
          <Due>2026-05-12T08:36:42.1262521-04:00</Due>
          <LogComments>sample string 4</LogComments>
          <Price>1.1</Price>
          <Surcharge>1.1</Surcharge>
          <TAT>1</TAT>
          <VersionID>sample string 3</VersionID>
        </SampleSubmissionAnalysisRequest>
      </Analyses>
      <BegDepth>1.1</BegDepth>
      <CasingDiameter>sample string 17</CasingDiameter>
      <CasingHeight>sample string 16</CasingHeight>
      <CasingType>sample string 18</CasingType>
      <ClientMatrixName>sample string 8</ClientMatrixName>
      <Containers>
        <SampleContainerRequestUpdate>
          <Amount>1.1</Amount>
          <Comments>sample string 5</Comments>
          <ContLotNum>sample string 6</ContLotNum>
          <Cooler>sample string 4</Cooler>
          <Designator>sample string 1</Designator>
          <SpecialInfos>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
          </SpecialInfos>
          <SxContainerKey>sample string 2</SxContainerKey>
          <SxContainerName>sample string 3</SxContainerName>
        </SampleContainerRequestUpdate>
        <SampleContainerRequestUpdate>
          <Amount>1.1</Amount>
          <Comments>sample string 5</Comments>
          <ContLotNum>sample string 6</ContLotNum>
          <Cooler>sample string 4</Cooler>
          <Designator>sample string 1</Designator>
          <SpecialInfos>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
          </SpecialInfos>
          <SxContainerKey>sample string 2</SxContainerKey>
          <SxContainerName>sample string 3</SxContainerName>
        </SampleContainerRequestUpdate>
      </Containers>
      <DepthUnits>sample string 12</DepthUnits>
      <Elevation>sample string 20</Elevation>
      <EndDepth>1.1</EndDepth>
      <Gradient>sample string 15</Gradient>
      <Latitude>sample string 13</Latitude>
      <Longitude>sample string 14</Longitude>
      <MatrixKey>sample string 6</MatrixKey>
      <MatrixName>sample string 7</MatrixName>
      <Sample>sample string 1</Sample>
      <SampleAlias>sample string 3</SampleAlias>
      <SampleComments>sample string 11</SampleComments>
      <SampleName>sample string 2</SampleName>
      <SampleRegID>sample string 4</SampleRegID>
      <SampleType>sample string 5</SampleType>
      <Sampled>2026-05-12T08:36:42.1262521-04:00</Sampled>
      <SampledBegin>2026-05-12T08:36:42.1262521-04:00</SampledBegin>
      <SampledBy>sample string 9</SampledBy>
      <SpecialInfos>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
      </SpecialInfos>
      <TimeZoneKey>1</TimeZoneKey>
      <TimeZoneName>sample string 10</TimeZoneName>
      <WellDepth>sample string 19</WellDepth>
      <isNotCollected>true</isNotCollected>
    </SampleRequestUpdate>
    <SampleRequestUpdate>
      <Analyses>
        <SampleSubmissionAnalysisRequest>
          <AnalysisKey>sample string 1</AnalysisKey>
          <AnalysisName>sample string 2</AnalysisName>
          <Due>2026-05-12T08:36:42.1262521-04:00</Due>
          <LogComments>sample string 4</LogComments>
          <Price>1.1</Price>
          <Surcharge>1.1</Surcharge>
          <TAT>1</TAT>
          <VersionID>sample string 3</VersionID>
        </SampleSubmissionAnalysisRequest>
        <SampleSubmissionAnalysisRequest>
          <AnalysisKey>sample string 1</AnalysisKey>
          <AnalysisName>sample string 2</AnalysisName>
          <Due>2026-05-12T08:36:42.1262521-04:00</Due>
          <LogComments>sample string 4</LogComments>
          <Price>1.1</Price>
          <Surcharge>1.1</Surcharge>
          <TAT>1</TAT>
          <VersionID>sample string 3</VersionID>
        </SampleSubmissionAnalysisRequest>
      </Analyses>
      <BegDepth>1.1</BegDepth>
      <CasingDiameter>sample string 17</CasingDiameter>
      <CasingHeight>sample string 16</CasingHeight>
      <CasingType>sample string 18</CasingType>
      <ClientMatrixName>sample string 8</ClientMatrixName>
      <Containers>
        <SampleContainerRequestUpdate>
          <Amount>1.1</Amount>
          <Comments>sample string 5</Comments>
          <ContLotNum>sample string 6</ContLotNum>
          <Cooler>sample string 4</Cooler>
          <Designator>sample string 1</Designator>
          <SpecialInfos>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
          </SpecialInfos>
          <SxContainerKey>sample string 2</SxContainerKey>
          <SxContainerName>sample string 3</SxContainerName>
        </SampleContainerRequestUpdate>
        <SampleContainerRequestUpdate>
          <Amount>1.1</Amount>
          <Comments>sample string 5</Comments>
          <ContLotNum>sample string 6</ContLotNum>
          <Cooler>sample string 4</Cooler>
          <Designator>sample string 1</Designator>
          <SpecialInfos>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
            <SpecialInfoRequest>
              <Answer>sample string 2</Answer>
              <DisplayName>sample string 1</DisplayName>
            </SpecialInfoRequest>
          </SpecialInfos>
          <SxContainerKey>sample string 2</SxContainerKey>
          <SxContainerName>sample string 3</SxContainerName>
        </SampleContainerRequestUpdate>
      </Containers>
      <DepthUnits>sample string 12</DepthUnits>
      <Elevation>sample string 20</Elevation>
      <EndDepth>1.1</EndDepth>
      <Gradient>sample string 15</Gradient>
      <Latitude>sample string 13</Latitude>
      <Longitude>sample string 14</Longitude>
      <MatrixKey>sample string 6</MatrixKey>
      <MatrixName>sample string 7</MatrixName>
      <Sample>sample string 1</Sample>
      <SampleAlias>sample string 3</SampleAlias>
      <SampleComments>sample string 11</SampleComments>
      <SampleName>sample string 2</SampleName>
      <SampleRegID>sample string 4</SampleRegID>
      <SampleType>sample string 5</SampleType>
      <Sampled>2026-05-12T08:36:42.1262521-04:00</Sampled>
      <SampledBegin>2026-05-12T08:36:42.1262521-04:00</SampledBegin>
      <SampledBy>sample string 9</SampledBy>
      <SpecialInfos>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
        <SpecialInfoRequest>
          <Answer>sample string 2</Answer>
          <DisplayName>sample string 1</DisplayName>
        </SpecialInfoRequest>
      </SpecialInfos>
      <TimeZoneKey>1</TimeZoneKey>
      <TimeZoneName>sample string 10</TimeZoneName>
      <WellDepth>sample string 19</WellDepth>
      <isNotCollected>true</isNotCollected>
    </SampleRequestUpdate>
  </Samples>
  <Shipper>sample string 17</Shipper>
  <SpecialInfos>
    <SpecialInfoRequest>
      <Answer>sample string 2</Answer>
      <DisplayName>sample string 1</DisplayName>
    </SpecialInfoRequest>
    <SpecialInfoRequest>
      <Answer>sample string 2</Answer>
      <DisplayName>sample string 1</DisplayName>
    </SpecialInfoRequest>
  </SpecialInfos>
  <Status>Pending</Status>
  <StatusByKey>sample string 12</StatusByKey>
  <StatusByName>sample string 13</StatusByName>
  <StatusDate>2026-05-12T08:36:42.1262521-04:00</StatusDate>
  <SubmissionComments>sample string 11</SubmissionComments>
  <SubmissionDate>2026-05-12T08:36:42.1262521-04:00</SubmissionDate>
  <SubmissionKey>sample string 1</SubmissionKey>
  <TAT>1</TAT>
  <UserKey>sample string 3</UserKey>
  <UserName>sample string 4</UserName>
  <WorkOrder>sample string 10</WorkOrder>
</SampleSubmissionUpdate>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SampleSubmissionDetail

Name	Type	Additional information
ProjectNumber	string	None.
COCNum	string	None.
BOLNum	string	None.
Shipper	string	None.
PONumber	string	None.
SDGID	string	None.
TAT	integer	None.
Due	date	None.
ProjBillCode	string	None.
Samples	Collection of Sample	None.
Coolers	Collection of SampleSubmissionCooler	None.
SpecialInfos	Collection of SpecialInfo	None.
SubmissionKey	string	None.
SubmissionID	string	None.
SubmissionDate	date	None.
UserKey	string	None.
UserName	string	None.
FacilityCode	string	None.
ClientID	string	None.
ClientName	string	None.
ProjectKey	string	None.
ProjectName	string	None.
CancelRequested	date	None.
ProcessDate	date	None.
WorkOrder	string	None.
SubmissionComments	string	None.
SampleCount	integer	None.
Status	SampleSumissionStatus	None.
StatusByKey	string	None.
StatusByName	string	None.
StatusDate	date	None.

Response Formats

application/json, text/json

Sample:

Sample not available.