POST api/Parcel/Edit?authToken={authToken}

Edits the user specified by the authentication token.

Request Information

URI Parameters

Name	Description	Type	Additional information
authToken	The authentication token.	string	Required

Body Parameters

The entity model.

ParcelEditModel

Name	Type	Additional information
Id	globally unique identifier	Required
Name	string	Required Max length: 256
Comments	string	Max length: 256
Reference	string	Max length: 20
ATCode	string	Max length: 80
InsuranceType	InsuranceType	None.
InsuranceLevelId	globally unique identifier	None.
CollectionAddress	string	Required Max length: 256
CollectionZipCode	string	Required Max length: 128
CollectionPhone	string	Max length: 256
CollectionName	string	Max length: 256
CollectionCity	string	Required Max length: 128
CollectionCountry	globally unique identifier	Required
DestinationName	string	Max length: 256
DestinationEmail	string	Required Max length: 128
DestinationPhone	string	Max length: 128
DestinationAddress	string	Required Max length: 190
DestinationZipCode	string	Required Max length: 128
DestinationCity	string	Required Max length: 128
DestinationCountry	globally unique identifier	Required
Packages	Collection of PackageEditModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": "0493d3b0-d04d-4ce1-927f-1692ad6d22dd",
  "Name": "sample string 2",
  "Comments": "sample string 3",
  "Reference": "sample string 4",
  "ATCode": "sample string 5",
  "InsuranceType": 1,
  "InsuranceLevelId": "0018d2bf-460f-45d0-bbed-1033ea6e8606",
  "CollectionAddress": "sample string 6",
  "CollectionZipCode": "sample string 7",
  "CollectionPhone": "sample string 8",
  "CollectionName": "sample string 9",
  "CollectionCity": "sample string 10",
  "CollectionCountry": "4d055aaa-c9ec-4d11-ae7d-da130e428968",
  "DestinationName": "sample string 12",
  "DestinationEmail": "sample string 13",
  "DestinationPhone": "sample string 14",
  "DestinationAddress": "sample string 15",
  "DestinationZipCode": "sample string 16",
  "DestinationCity": "sample string 17",
  "DestinationCountry": "89913ded-9a0a-4731-9c32-3cc2160d7187",
  "Packages": [
    {
      "Name": "sample string 1",
      "Weight": 1.0,
      "Height": 1.0,
      "Width": 1.0,
      "Length": 1.0,
      "ExternalCode": 1,
      "ExternalOperatorId": "dcc82392-f9c6-4756-8506-9f7e00ae50b7",
      "Id": "3235c99c-c9ed-4a63-a2fc-4a58719f4a34",
      "BidParcelId": "sample string 3"
    },
    {
      "Name": "sample string 1",
      "Weight": 1.0,
      "Height": 1.0,
      "Width": 1.0,
      "Length": 1.0,
      "ExternalCode": 1,
      "ExternalOperatorId": "dcc82392-f9c6-4756-8506-9f7e00ae50b7",
      "Id": "3235c99c-c9ed-4a63-a2fc-4a58719f4a34",
      "BidParcelId": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<ParcelEditModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Apps.Web.Areas.Api.Models">
  <ATCode>sample string 5</ATCode>
  <CollectionAddress>sample string 6</CollectionAddress>
  <CollectionCity>sample string 10</CollectionCity>
  <CollectionCountry>4d055aaa-c9ec-4d11-ae7d-da130e428968</CollectionCountry>
  <CollectionName>sample string 9</CollectionName>
  <CollectionPhone>sample string 8</CollectionPhone>
  <CollectionZipCode>sample string 7</CollectionZipCode>
  <Comments>sample string 3</Comments>
  <DestinationAddress>sample string 15</DestinationAddress>
  <DestinationCity>sample string 17</DestinationCity>
  <DestinationCountry>89913ded-9a0a-4731-9c32-3cc2160d7187</DestinationCountry>
  <DestinationEmail>sample string 13</DestinationEmail>
  <DestinationName>sample string 12</DestinationName>
  <DestinationPhone>sample string 14</DestinationPhone>
  <DestinationZipCode>sample string 16</DestinationZipCode>
  <Id>0493d3b0-d04d-4ce1-927f-1692ad6d22dd</Id>
  <InsuranceLevelId>0018d2bf-460f-45d0-bbed-1033ea6e8606</InsuranceLevelId>
  <InsuranceType>InsuranceFixedValue</InsuranceType>
  <Name>sample string 2</Name>
  <Packages>
    <PackageEditModel>
      <BidParcelId>sample string 3</BidParcelId>
      <ExternalCode>1</ExternalCode>
      <ExternalOperatorId>dcc82392-f9c6-4756-8506-9f7e00ae50b7</ExternalOperatorId>
      <Height>1</Height>
      <Id>3235c99c-c9ed-4a63-a2fc-4a58719f4a34</Id>
      <Length>1</Length>
      <Name>sample string 1</Name>
      <Weight>1</Weight>
      <Width>1</Width>
    </PackageEditModel>
    <PackageEditModel>
      <BidParcelId>sample string 3</BidParcelId>
      <ExternalCode>1</ExternalCode>
      <ExternalOperatorId>dcc82392-f9c6-4756-8506-9f7e00ae50b7</ExternalOperatorId>
      <Height>1</Height>
      <Id>3235c99c-c9ed-4a63-a2fc-4a58719f4a34</Id>
      <Length>1</Length>
      <Name>sample string 1</Name>
      <Weight>1</Weight>
      <Width>1</Width>
    </PackageEditModel>
  </Packages>
  <Reference>sample string 4</Reference>
</ParcelEditModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ServiceResult

Name	Type	Additional information
ErrorCode	ServiceErrorCode	None.
ErrorMessage	Collection of string	None.
Success	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "ErrorCode": 0,
  "ErrorMessage": [
    "sample string 1",
    "sample string 2"
  ],
  "Success": true
}

application/xml, text/xml

Sample:

<ServiceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOP.Common.Infrastructure.ApiObjects.Results">
  <ErrorCode>None</ErrorCode>
  <ErrorMessage xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorMessage>
  <Success>true</Success>
</ServiceResult>