Developer Portal
InsightsPurpleTRAC
MTIPodium
Other
Other
  • Weather
InsightsPurpleTRAC
MTIPodium
Other
Other
  • Weather
    • Start Here
      • Overview
      • Getting started
      • Authentication
      • Testing
      • Errors & status codes
      • FAQ
    • General
      • Retrieve a list of vessels
      • Additional entity search
    • Screening
      • Screening a vessel
      • Watchlist checks
      • Additional checks
      • Movement history
      • Carbon rating
      • Submit a vessel for screening
      • Retrieve a list of transactions and their screening results
      • Ship & Flag Watchlist check
      • Company Watchlist check
      • Country Sanctions check
      • Ship movement history
      • Ship-to-Ship (STS) pairing screening
      • Company history check
      • P&I Club check
      • Vessel operational status
      • Flag history check
      • AIS positional discrepancy (spoofing) events
      • Periods of Non-Reporting
      • Carbon rating details
      • Get the PurpleTRAC Screening Report PDF
      • Submit a vessel for rescreening
      • Archive a Screening
    • Tracking
      • Voyage updates
      • Notification catalogue
      • Additional entities
      • Tracking a vessel
      • Enable a vessel for tracking
      • Remove additional entities from a tracked vessel
      • Add additional entities to a tracked vessel
      • List the additional entities on a transaction
      • Update voyage and tracking details
      • Get vessel positional data
      • Retrieve a list of vessel or bill of lading notifications
      • Get the PurpleTRAC Trade Report PDF
    • Bill of Lading
      • Carriers
      • Verification
      • Submit a Bill of Lading for screening
      • Get all BL Screening Results
      • Get a single BL screening result
      • Get the PurpleTRAC Bill of Lading Screening Report PDF
      • Enable tracking for a screened Bill of Lading
      • Get the PurpleTRAC Bill of Lading Tracking Report PDF
      • Disable tracking for a Bill of Lading
    • Containers
      • Screening
      • Carriers
      • Submit a Container for screening
      • Get all Container Screening Results
      • Archive Container
      • Get a single Container screening result
      • Get the Container report
    • Schemas
      • BLVGetAllResultsResponse
      • BLVScreeningResponse
      • BLVLastScreeningResult
      • BLVScreeningResultDetails
      • ContainerRegistrationBody
      • ContainerRegistrationResponse
      • ContainerGetAllResultsResponse
      • ContainerScreeningResponse
      • CarbonRatings
      • CarbonRating
      • CompanySanctions
      • CompanySanction
      • CountryChecks
      • CountryCheck
      • StsPairings
      • StsPairing
      • OtherAssociations
      • OtherAssociation
      • CompanyHistoryChecks
      • CompanyHistoryCheck
      • ShipStatuses
      • ShipStatus
      • FlagHistoryChecks
      • FlagHistoryCheck
      • PositionalDiscrepancies
      • PositionalDiscrepancy
      • DiscrepancyZone
      • DiscrepancyPort
      • NonReportingResponse
      • NonReporting
      • Notifications
      • Notification
      • BLVNotification
      • BLVPortFull
      • BLVPortFallback
      • PortCallHistory
      • PortCallHistoryItem
      • Positions
      • Position
      • PositionInfo
      • RegistrationResponse
      • ShipDetails
      • ShipSanctions
      • ShipSanction
      • VesselTrackingResponse
      • VesselTransactionsResponse
      • Transaction
      • TransactionPutBody
      • TransactionPutResponse
      • TransactionRescreenResponse
      • LastPosition
      • ScreeningNotification
      • ScreeningResult
      • UserDetails
      • UserProfile
      • Error
      • InvalidContainerNumberResponse
      • VesselRegistrationBody
      • VesselTrackingRequest
      • BLRegistrationBody
      • AdditionalEntitySearchResponse
      • AdditionalEntity
      • AdditionalEntitiesRequestSchema
      • TrackingAdditionalEntity
      • TrackingAdditionalEntitiesResponse
      • TrackingAdditionalEntityInput
      • TrackingAdditionalEntitiesPutBody
      • TrackingAdditionalEntitiesPutResponse
      • TrackingAdditionalEntitiesDeleteBody
      • RemovedAdditionalEntity
      • TrackingAdditionalEntitiesDeleteResponse
      • TrackingAdditionalEntityError
      • FeatureDisabledError
      • ObjectNotFoundError
      • TransactionValidationError
      • VoyageUpdateRequest
      • VoyageUpdateResponse
      • PTracMeta
      • PTracVessel
      • PTracVesselSearchResponse
      • DuplicateTransactionError

    TrackingAdditionalEntitiesPutResponse(TrackingAdditionalEntitiesPutResponse)

    Confirms the additional entities which were added to the transaction.
    Note that the entities are echoed back from the request payload, so unlike the GET method the objects in this response do not include an id field.

    {
        "transaction_id": 123,
        "additional_entities": [
            {
                "name": "Hello Bank!",
                "relationship": "Financier",
                "type": "organisation",
                "obj_id": 1039902
            }
        ]
    }
    Built with