POST api/_ext/ExternalShips/UpdatePlannedParcel

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PARCEL_SEQUENCE	decimal number	None.
USER_NAME	string	None.
NOMINATED_TONS	decimal number	None.
SUBSTITUES_THE	string	None.
SUBSTITUES_THE_NAME	string	None.
SUBSTITUTED_BY	string	None.
SUBSTITUTED_DATE	date	None.
CEDED_FROM	string	None.
CEDED_DATE	date	None.
CEDED_BY	string	None.
CEDED_FROM_PARCEL	decimal number	None.
CEDED_TO_PARCEL	decimal number	None.
WITHDRAWN_DATE	date	None.
WITHDRAWN_BY	string	None.
USER_GRADES	Collection of string	None.
GRADES	Collection of string	None.
SPLIT	boolean	None.
VISIT_SEQUENCE	decimal number	None.
NOMINATED_DATE	date	None.
NOMINATED_BY	string	None.
CAN_SEE	boolean	None.
IN_CEDE_APPROVAL	boolean	None.
IN_CEDE_CEDER	boolean	None.
IN_CEDE_CEDEE	boolean	None.
IN_CEDE_TONS	decimal number	None.
SHAREHOLDER_UID	string	None.
PARCEL_CODE	string	None.
AUDIT_WARNINGS	Collection of AUDIT_WARNING	None.

Request Formats

application/json, text/json

Sample:

{
  "PARCEL_SEQUENCE": 1.0,
  "USER_NAME": "sample string 1",
  "NOMINATED_TONS": 2.0,
  "SUBSTITUES_THE": "sample string 3",
  "SUBSTITUES_THE_NAME": "sample string 4",
  "SUBSTITUTED_BY": "sample string 5",
  "SUBSTITUTED_DATE": "2026-02-12T19:50:06.2827191+02:00",
  "CEDED_FROM": "sample string 6",
  "CEDED_DATE": "2026-02-12T19:50:06.2827191+02:00",
  "CEDED_BY": "sample string 7",
  "CEDED_FROM_PARCEL": 1.0,
  "CEDED_TO_PARCEL": 1.0,
  "WITHDRAWN_DATE": "2026-02-12T19:50:06.2827191+02:00",
  "WITHDRAWN_BY": "sample string 8",
  "USER_GRADES": [
    "sample string 1",
    "sample string 2"
  ],
  "GRADES": [
    "sample string 1",
    "sample string 2"
  ],
  "SPLIT": true,
  "VISIT_SEQUENCE": 1.0,
  "NOMINATED_DATE": "2026-02-12T19:50:06.2827191+02:00",
  "NOMINATED_BY": "sample string 10",
  "CAN_SEE": true,
  "IN_CEDE_APPROVAL": true,
  "IN_CEDE_CEDER": true,
  "IN_CEDE_CEDEE": true,
  "IN_CEDE_TONS": 15.0,
  "SHAREHOLDER_UID": "sample string 16",
  "PARCEL_CODE": "sample string 17",
  "AUDIT_WARNINGS": [
    {
      "CODE": "sample string 1",
      "TIMESTAMP": "2026-02-12T19:50:06.2827191+02:00"
    },
    {
      "CODE": "sample string 1",
      "TIMESTAMP": "2026-02-12T19:50:06.2827191+02:00"
    }
  ]
}

application/xml, text/xml

Sample:

<PlannedParcelViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RBCT.Core.ViewModels">
  <AUDIT_WARNINGS>
    <AUDIT_WARNING>
      <CODE>sample string 1</CODE>
      <TIMESTAMP>2026-02-12T19:50:06.2827191+02:00</TIMESTAMP>
    </AUDIT_WARNING>
    <AUDIT_WARNING>
      <CODE>sample string 1</CODE>
      <TIMESTAMP>2026-02-12T19:50:06.2827191+02:00</TIMESTAMP>
    </AUDIT_WARNING>
  </AUDIT_WARNINGS>
  <CAN_SEE>true</CAN_SEE>
  <CEDED_BY>sample string 7</CEDED_BY>
  <CEDED_DATE>2026-02-12T19:50:06.2827191+02:00</CEDED_DATE>
  <CEDED_FROM>sample string 6</CEDED_FROM>
  <CEDED_FROM_PARCEL>1</CEDED_FROM_PARCEL>
  <CEDED_TO_PARCEL>1</CEDED_TO_PARCEL>
  <GRADES xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </GRADES>
  <IN_CEDE_APPROVAL>true</IN_CEDE_APPROVAL>
  <IN_CEDE_CEDEE>true</IN_CEDE_CEDEE>
  <IN_CEDE_CEDER>true</IN_CEDE_CEDER>
  <IN_CEDE_TONS>15</IN_CEDE_TONS>
  <NOMINATED_BY>sample string 10</NOMINATED_BY>
  <NOMINATED_DATE>2026-02-12T19:50:06.2827191+02:00</NOMINATED_DATE>
  <NOMINATED_TONS>2</NOMINATED_TONS>
  <PARCEL_CODE>sample string 17</PARCEL_CODE>
  <PARCEL_SEQUENCE>1</PARCEL_SEQUENCE>
  <SHAREHOLDER_UID>sample string 16</SHAREHOLDER_UID>
  <SPLIT>true</SPLIT>
  <SUBSTITUES_THE>sample string 3</SUBSTITUES_THE>
  <SUBSTITUES_THE_NAME>sample string 4</SUBSTITUES_THE_NAME>
  <SUBSTITUTED_BY>sample string 5</SUBSTITUTED_BY>
  <SUBSTITUTED_DATE>2026-02-12T19:50:06.2827191+02:00</SUBSTITUTED_DATE>
  <USER_GRADES xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </USER_GRADES>
  <USER_NAME>sample string 1</USER_NAME>
  <VISIT_SEQUENCE>1</VISIT_SEQUENCE>
  <WITHDRAWN_BY>sample string 8</WITHDRAWN_BY>
  <WITHDRAWN_DATE>2026-02-12T19:50:06.2827191+02:00</WITHDRAWN_DATE>
</PlannedParcelViewModel>

multipart/form-data

Sample:

<PlannedParcelViewModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RBCT.Core.ViewModels"><AUDIT_WARNINGS><AUDIT_WARNING><CODE>sample string 1</CODE><TIMESTAMP>2026-02-12T19:50:06.2827191+02:00</TIMESTAMP></AUDIT_WARNING><AUDIT_WARNING><CODE>sample string 1</CODE><TIMESTAMP>2026-02-12T19:50:06.2827191+02:00</TIMESTAMP></AUDIT_WARNING></AUDIT_WARNINGS><CAN_SEE>true</CAN_SEE><CEDED_BY>sample string 7</CEDED_BY><CEDED_DATE>2026-02-12T19:50:06.2827191+02:00</CEDED_DATE><CEDED_FROM>sample string 6</CEDED_FROM><CEDED_FROM_PARCEL>1</CEDED_FROM_PARCEL><CEDED_TO_PARCEL>1</CEDED_TO_PARCEL><GRADES xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></GRADES><IN_CEDE_APPROVAL>true</IN_CEDE_APPROVAL><IN_CEDE_CEDEE>true</IN_CEDE_CEDEE><IN_CEDE_CEDER>true</IN_CEDE_CEDER><IN_CEDE_TONS>15</IN_CEDE_TONS><NOMINATED_BY>sample string 10</NOMINATED_BY><NOMINATED_DATE>2026-02-12T19:50:06.2827191+02:00</NOMINATED_DATE><NOMINATED_TONS>2</NOMINATED_TONS><PARCEL_CODE>sample string 17</PARCEL_CODE><PARCEL_SEQUENCE>1</PARCEL_SEQUENCE><SHAREHOLDER_UID>sample string 16</SHAREHOLDER_UID><SPLIT>true</SPLIT><SUBSTITUES_THE>sample string 3</SUBSTITUES_THE><SUBSTITUES_THE_NAME>sample string 4</SUBSTITUES_THE_NAME><SUBSTITUTED_BY>sample string 5</SUBSTITUTED_BY><SUBSTITUTED_DATE>2026-02-12T19:50:06.2827191+02:00</SUBSTITUTED_DATE><USER_GRADES xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"><d2p1:string>sample string 1</d2p1:string><d2p1:string>sample string 2</d2p1:string></USER_GRADES><USER_NAME>sample string 1</USER_NAME><VISIT_SEQUENCE>1</VISIT_SEQUENCE><WITHDRAWN_BY>sample string 8</WITHDRAWN_BY><WITHDRAWN_DATE>2026-02-12T19:50:06.2827191+02:00</WITHDRAWN_DATE></PlannedParcelViewModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml, multipart/form-data

Sample:

Sample not available.