Portbase Waste Collector API

The Waste Collector API API from Portbase — 4 operation(s) for waste collector api.

Operations 4

POST /waste-collector/wastecollection:cancel Cancel waste collection #
POST /waste-collector/wastecollection:complete Complete waste collection #
POST /waste-collector/wastecollection:register Register waste collection #
POST /waste-collector/wastecollection:financials Submit waste collection financials #

Documentation

Specifications

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-booking-dossier-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-subscribe-dto-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-subscription-id-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-track-response-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-api-organisation-bl-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-shipment-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-transfer-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-batch-track-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-terminal-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-equipment-create-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-equipment-update-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-container-list-item-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-get-road-voyage-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-get-hinterland-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-external-visit-api-visit-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-common-authentication-bezoekschip-organisation-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-commercialrelease-input-input-commercial-release-data-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-common-get-any-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-com-portbase-bezoekschip-common-api-visit-get-visit-updates-schema.json
📊
JSONSchema
https://artifacts.apis.io/portbase/json-schema/portbase-import-consignment-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/portbase:portbase-waste-collector-api-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

portbase-waste-collector-api-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Portbase Waste Collector API
  version: '6.0'
  contact:
    name: Portbase portvisit team
    url: https://portvisit.pcs.portbase.com
    email: customerservice@portbase.com
  x-logo:
    url: Portbase_WB_RGB.png
    altText: Portbase logo
  description: 'Operations tagged Waste Collector API across 2 of this provider''s published API definitions: portbase-portvisit-v6.json, portbase-vessel-visit-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.portbase.com/portvisit
  description: Production server
- url: https://api.kt.portbase.com/portvisit
  description: Acceptance server
- url: https://api.sc.portbase.com/portvisit
  description: Test server
tags:
- name: Waste Collector API
paths:
  /waste-collector/wastecollection:cancel:
    post:
      tags:
      - Waste Collector API
      summary: Cancel waste collection
      description: This endpoint can be used to cancel a registered waste collection.
      operationId: cancelWasteCollection
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputCancelWasteCollection'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /waste-collector/wastecollection:complete:
    post:
      tags:
      - Waste Collector API
      summary: Complete waste collection
      description: This endpoint can be used to complete a waste collection by filling in the actual times.
      operationId: completeWasteCollection
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputCompleteWasteCollection'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /waste-collector/wastecollection:register:
    post:
      tags:
      - Waste Collector API
      summary: Register waste collection
      description: This endpoint can be used to register a waste collection.
      operationId: registerWasteCollection
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputRegisterWasteCollection'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
  /waste-collector/wastecollection:financials:
    post:
      tags:
      - Waste Collector API
      summary: Submit waste collection financials
      description: This endpoint can be used to fill in all financial data of a waste collection.
      operationId: submitFinancialsForWasteCollection
      requestBody:
        content:
          '*/*':
            schema:
              $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputSubmitFinancials'
      responses:
        '204':
          description: successful operation
    servers:
    - url: https://api.portbase.com/portvisit
      description: Production server
    - url: https://api.kt.portbase.com/portvisit
      description: Acceptance server
    - url: https://api.sc.portbase.com/portvisit
      description: Test server
components:
  schemas:
    com.portbase.bezoekschip.common.api.waste.collector.input.InputCancelWasteCollection:
      title: InputCancelWasteCollection
      required:
      - collectionId
      - crn
      - imo
      type: object
      properties:
        crn:
          minLength: 1
          type: string
        imo:
          minLength: 1
          type: string
        collectionId:
          minLength: 1
          type: string
    com.portbase.bezoekschip.common.api.waste.collector.input.InputSubmitFinancials:
      title: InputSubmitFinancials
      required:
      - crn
      - imo
      - timestamp
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The crn of the visit. The vessel should have arrived at the port.
        imo:
          minLength: 1
          type: string
          description: The imo number of the vessel.
        collection:
          $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputWasteCollection'
        timestamp:
          type: string
          description: The time that the command was sent.
          format: date-time
      description: Submit financials by collector. (equivalent of EOVMF)
    com.portbase.bezoekschip.common.api.waste.collector.input.InputCompleteWasteCollection:
      title: InputCompleteWasteCollection
      required:
      - crn
      - imo
      - timestamp
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The crn of the visit. The vessel should have arrived at the port.
        imo:
          minLength: 1
          type: string
          description: The imo number of the vessel.
        collection:
          $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputWasteCollection'
        timestamp:
          type: string
          description: The time that the command was sent.
          format: date-time
      description: Complete waste collection by collector. (equivalent of EOVM)
    com.portbase.bezoekschip.common.api.waste.collector.input.InputCollectedItem:
      title: InputCollectedItem
      required:
      - ssnCode
      type: object
      properties:
        ssnCode:
          minLength: 1
          type: string
        typeCode:
          type:
          - string
          - 'null'
        receptionFacility:
          type:
          - string
          - 'null'
        amount:
          type:
          - number
          - 'null'
        directCost:
          type:
          - number
          - 'null'
        indirectCost:
          type:
          - number
          - 'null'
        specification:
          type:
          - string
          - 'null'
      description: The waste items.
    com.portbase.bezoekschip.common.api.waste.collector.input.InputWasteCollection:
      title: InputWasteCollection
      required:
      - id
      - startTime
      type: object
      properties:
        id:
          minLength: 1
          type: string
          description: The id of the collection. This id links register, complete and submit financials.
        sformNumber:
          type:
          - string
          - 'null'
          description: The name of the S-Form (required in CompleteCollection and SubmitFinancials).
        remarks:
          type:
          - string
          - 'null'
          description: Extra remarks for on the S-Form.
        berthVisitId:
          type:
          - string
          - 'null'
          description: The berthVisitId (either berthVisitId of locationName should be filled).
        locationName:
          type:
          - string
          - 'null'
          description: The locationName (either berthVisitId of locationName should be filled).
        fixedCosts:
          type:
          - number
          - 'null'
          description: The fixed costs of the collection (either berthVisitId of locationName should be filled).
        items:
          type: array
          description: The waste items.
          items:
            $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputCollectedItem'
        startTime:
          type: string
          description: The time of the start of the collection.
          format: date-time
        endTime:
          type:
          - string
          - 'null'
          description: The time that the collection has completed (required in CompleteCollection and SubmitFinancials).
          format: date-time
      description: The collection to be registered, completed, of for which financials should be submitted.
    com.portbase.bezoekschip.common.api.waste.collector.input.InputRegisterWasteCollection:
      title: InputRegisterWasteCollection
      required:
      - crn
      - imo
      - timestamp
      type: object
      properties:
        crn:
          minLength: 1
          type: string
          description: The crn of the visit. The vessel should have arrived at the port.
        imo:
          minLength: 1
          type: string
          description: The imo number of the vessel.
        collection:
          $ref: '#/components/schemas/com.portbase.bezoekschip.common.api.waste.collector.input.InputWasteCollection'
        timestamp:
          type: string
          description: The time that the command was sent.
          format: date-time
      description: Register waste by collector. (equivalent of EOPM)
x-refined-from:
- portbase-portvisit-v6.json
- portbase-vessel-visit-openapi.yml