POST /waste-transfers/{id}/actuals

Adds an actual transfer to a waste transfer note.

Authentication and Authorisation

Requires API Access Token Requires Basic Authentication (Username/Password) Requires one of the following roles
True True TransferManager

Request Information

Parameters

Name Source Description
id Part of the URI route path The edoc generated unique identifier of the waste transfer note.
actualWasteTransfer Part of the request HTTP body The actual transfer.

Parameter Properties

  • actualWasteTransfer
    • ActualWeight
      The actual weight of the collection.
    • ActualWeightUnit
      The unit of weight used.
    • ContainerDescription
      A more detailed description of the waste container (e.g. in the case of "Other" Container Type).
    • ContainerType
      edoc generated unique identifier for the container.
      Remarks: Mandatory.
    • Id
      edoc generated unique identifier for the actual waste description. Required when updating an actual waste description.
    • IntendedFate
      The fate of the waste for the actual transfer.
    • LastRecordedFate
      The most recently recorded fate of any waste description with corresponding tracker number(s). Not required for input, provided on output.
    • Quantity
      Number of containers.
    • ReferenceId
      Gets or sets the reference id.
    • Text
      Textual description of the waste.
      Remarks: Mandatory.
    • TrackingNumbers
      The tracking number(s) of the original waste so that the system can trace the last known fate of the waste.
    • TransferDate
      The date that the actual waste described was transferred.
      Remarks: Mandatory.
    • TransfereeWasteTonnage
      Gets or sets the transferee waste tonnage.
      • Biodegradable
        Indicates whether the waste received is biodegradable or not.
      • DisposalOrRecoveryCode
        The disposal or recovery code relevant to this waste received.
      • FromAnotherFacility
        The type of facility where the waste received came from.
      • PreTreatment
        The pre-treatment option.
      • MunicipalSource
        Indicates whether the waste received is from a municipal source or not.
      • State
        The physical state of the waste received.
    • TransferorWasteTonnage
      Gets or sets the transferor waste tonnage.
      • DestinationLocalAuthorityArea
        The local authority area where the waste removed is sent.
      • DestinationFacilityDisposalOrRecoveryCode
        The disposal or recovery code relevant to this waste removed.
      • MunicipalSource
        Indicates whether the waste removed is from a municipal source or not.
      • State
        The physical state of the waste removed.
    • Volume
      The volume of the actual waste transferred.
    • VolumeUnit
      Units of Volume used.
    • WasteStreamCodes
      Regulatory codes for the waste.
      Remarks: Mandatory.

Request body formats

Sample:
{
  "ActualWeight": 1.1,
  "ActualWeightUnit": "Kilograms",
  "ContainerDescription": "Example 1",
  "ContainerType": "d1a6338a-a9b9-4207-91b4-e66de3e46f0a",
  "Id": "f6d48f1f-5a42-424b-bbc0-6d2aed7aa17a",
  "IntendedFate": "6e241639-9d73-44a4-8f61-8018331893ca",
  "LastRecordedFate": "d8128b8b-7179-4b88-aa0c-b461b21f0752",
  "Quantity": 1.1,
  "ReferenceId": "Example 2",
  "Text": "Example 3",
  "TrackingNumbers": [
    "Example 1",
    "Example 2",
    "Example 3"
  ],
  "TransferDate": "2019-08-18T00:00:00+00:00",
  "TransfereeWasteTonnage": {
    "Biodegradable": true,
    "DisposalOrRecoveryCode": "ab27229f-943e-4c72-8d6a-33010ab14fe2",
    "FromAnotherFacility": "c452f11b-6ab9-4017-b291-47f2c9a0b2cc",
    "PreTreatment": "1d4df5bd-d55a-4e56-8adb-bc5f74e5aff5",
    "MunicipalSource": true,
    "State": "a4aaeab1-73e8-454e-909c-abbab359a9dc"
  },
  "TransferorWasteTonnage": {
    "DestinationLocalAuthorityArea": "Example 1",
    "DestinationFacilityDisposalOrRecoveryCode": "9cc358af-cc41-4d2c-b437-0ecf65ba12ff",
    "MunicipalSource": true,
    "State": "ec1d78cc-1b79-4179-bbbe-dd2664d11587"
  },
  "Volume": 1.1,
  "VolumeUnit": "CubicMetres",
  "WasteStreamCodes": [
    "Example 1",
    "Example 2",
    "Example 3"
  ]
}
Sample:
<ActualWasteDescription xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="edoc">
  <ActualWeight>1.1</ActualWeight>
  <ActualWeightUnit>Kilograms</ActualWeightUnit>
  <ContainerDescription>Example 1</ContainerDescription>
  <ContainerType>d1a6338a-a9b9-4207-91b4-e66de3e46f0a</ContainerType>
  <Id>f6d48f1f-5a42-424b-bbc0-6d2aed7aa17a</Id>
  <IntendedFate>6e241639-9d73-44a4-8f61-8018331893ca</IntendedFate>
  <LastRecordedFate>d8128b8b-7179-4b88-aa0c-b461b21f0752</LastRecordedFate>
  <Quantity>1.1</Quantity>
  <ReferenceId>Example 2</ReferenceId>
  <Text>Example 3</Text>
  <TrackingNumbers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Example 1</d2p1:string>
    <d2p1:string>Example 2</d2p1:string>
    <d2p1:string>Example 3</d2p1:string>
  </TrackingNumbers>
  <TransferDate>2019-08-18T00:00:00+00:00</TransferDate>
  <TransfereeWasteTonnage>
    <Biodegradable>true</Biodegradable>
    <DisposalOrRecoveryCode>ab27229f-943e-4c72-8d6a-33010ab14fe2</DisposalOrRecoveryCode>
    <FromAnotherFacility>c452f11b-6ab9-4017-b291-47f2c9a0b2cc</FromAnotherFacility>
    <MunicipalSource>true</MunicipalSource>
    <PreTreatment>1d4df5bd-d55a-4e56-8adb-bc5f74e5aff5</PreTreatment>
    <State>a4aaeab1-73e8-454e-909c-abbab359a9dc</State>
  </TransfereeWasteTonnage>
  <TransferorWasteTonnage>
    <DestinationFacilityDisposalOrRecoveryCode>9cc358af-cc41-4d2c-b437-0ecf65ba12ff</DestinationFacilityDisposalOrRecoveryCode>
    <DestinationLocalAuthorityArea>Example 1</DestinationLocalAuthorityArea>
    <MunicipalSource>true</MunicipalSource>
    <State>ec1d78cc-1b79-4179-bbbe-dd2664d11587</State>
  </TransferorWasteTonnage>
  <Volume>1.1</Volume>
  <VolumeUnit>CubicMetres</VolumeUnit>
  <WasteStreamCodes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>Example 1</d2p1:string>
    <d2p1:string>Example 2</d2p1:string>
    <d2p1:string>Example 3</d2p1:string>
  </WasteStreamCodes>
</ActualWasteDescription>