MQ Documentation 1.0

Operations

• SUB {API_ACCESS_KEY}.{locationId}.session.started

  When system receives from charger that sessions has started

  Operation ID{API_ACCESS_KEY}.*.session.started

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Started

  • application/json

  Payload

  Expand all

  object

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  ChargingSessionNumber

  string

  Friendly ID of the charging session

  ChargingSessionSourceId

  integer

  format: int16

  1 - Local charge point (CSO); 2 - Roaming CDR.

  ParkingFrom

  string

  format: date-time

  Parking start time. Normally empty if charger is not able to detect parking time.

  ParkingTo

  string

  format: date-time

  Parking end time. Normally empty if charger is not able to detect parking time.

  ConnectedFrom

  string

  format: date-time

  Connected from time. If system is not able to detect when vehicle was connected then connected start time is the same as the charging start time.

  ConnectedTo

  string

  format: date-time

  Connected to time. If system is not able to detect when vehicle was connected then connected to time is the same as the charging end time

  ChargingFrom

  string

  format: date-time

  Charging start time.

  ChargingTo

  string

  format: date-time

  Charging end time.

  MeterStart

  string

  format: date-time

  Meter value at session start. Depends on the charger if meter values is reset for each charging.

  MeterEnd

  string

  format: date-time

  Meter value at session end. Depends on the charger if meter values is reset for each charging.

  ActiveEnergyConsumption

  number

  format: float

  Active energy consumption during charging (kWh).

  MaxActivePower

  number

  format: float

  Max measured power during charging (kW).

  RoamingTypeId

  integer

  format: int16

  0 - Local sessions (Our users on our infrastructure); 1 - CPO (Others roaming on our infrastructure); 2 - EMSP (Our users on roaming infractructure); 3 - CPO&EMSP (Our users roaming or other users roaming on our infrastructure).

  RoamingSessionId

  string

  Roaming session id, collected from roaming partner, used as reference when communicating with partner.

  InstanceRoamingPlatformId

  integer

  format: int32

  Roaming platform id.

  ChargingSessionStopReasonId

  integer

  format: int16

  1 - Local stop; 2 - Remote stop by user; 3 - Emergency stop; 4 - Energy limit reached; 5 - EV disconnected; 6 - Deauthorized; 7 - Immediate reset; 8 - Local out of credit; 9 - Local reboot; 10 - Power loss; 11 - Power quality; 12 - SOC limit reached; 13 - Time limit reached; 14 - Unlock command; 15 - Other; 16 - Finished in back office at next session start; 17 - Finished in back office with availability changed event; 18 - Remote stop by operator; 19 - Error occured during charging; 20 - No more funds - charging time expired; 21 - No more funds - energy consumption reached.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  EvseFriendlyCode

  string

  Friendly code of the Evse.

  ChargingTypeId

  integer

  format: int16

  1 - AC; 2 - DC; 3 - Wireless.

  OutMaxPower

  number

  format: float

  Max Evse power (kW).

  NumberOfPhases

  integer

  format: int16

  null - when DC or undefined; 1 - Single phase, 3 - Three phase.

  ExternalCode

  string

  PaymentRequired

  integer

  format: int16

  0 - Disabled; 1 - Enabled.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  FriendlyCode

  string

  Friendly code of the connector.

  ConnectorTypeId

  integer

  format: int16

  0 - Unknown; 1 - Type 2 socket; 2 - Type 2 Mode socked; 3 - Type 2 plug; 4 - Type 2 Mode 2 plug; 5 - CHAdeMO Plug; 6 - CCS plug; 7 - Household German Type; 8 - Type1Socket; 9 - Tesla super charger connector; 10 - Type 3 socket; 11 - Type 3 plug; 12 - IEC60309 Single Phase; 13 - IEC60309 Three Phase; 14 - Small Paddle Inductive; 15 - Large Paddle Inductive; 16 - Type1Cable.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  ExternalCode

  string

  External Evse code. Normally entered into Ocean from ERP system.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Owner

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charge point owner as business partner.

  Name

  string

  Charger owner business partner name.

  AccountingSystemCode

  string

  Charger owner business partner external code. Normally this is ERP code.

  Additional properties are allowed.

  Location

  Expand all

  object

  LocationId

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyName

  string

  Friendly name of the location.

  FriendlyCode

  string

  Friendly code of the location.

  LocationTypeId

  integer

  format: int16

  Enumeration is defined by instance operator. Please get list from location editor.

  LocationAccessTypeId

  integer

  format: int16

  1 - Public accessible - Free access; 2 - Private - only for customers; 3 - Private - only for employees; 4 - Public access - payable; 5 - Private access - home; 6 - Private access - plug sharing; 7 - Public access - car sharing; 8 - Private access - only for residents; 9 - Public in working hours and only private out of working hours.

  Additional properties are allowed.

  Address

  Expand all

  object

  StreetName

  string

  Location address (street name).

  HouseNumber

  string

  Location address (house number).

  CityName

  string

  Location address (city name).

  PostNumber

  string

  Location address (post number).

  CountryCode

  string

  Location address (country code).

  Additional properties are allowed.

  Roaming

  Expand all

  object

  RoamingPlatform

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform.

  Title

  string

  Roaming platform title.

  RoamingActor

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform actor/partner.

  Code

  string

  Unique code of the roaming actor on a specific platform.

  Title

  string

  Title of roaming actor on specific platform.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  ChargingAuthorization

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the charging authorization.

  Number

  string

  Friendly ID of the charging authorization.

  AuthorizationSourceId

  integer

  format: int16

  1 - Local charge point (CSO); 2 - Roaming live authorization request requested; 3 - Local EMSP user interface (web or mobile); 4 - Manually initiated by CSO operator; 5 - Roaming live authorization request received; 6 - Roaming remote start command send; 7 - Roaming remote start command received; 8 - Api authorization request received; 9 - Api authorization request requested; 10 - Api remote start command received

  ServerReceivedTimestamp

  string

  format: date-time

  Authorization request received timestamp.

  Payable

  integer

  format: int16

  0 - Disabled; 1 - Enabled.

  Identification

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the identification.

  IdentificationType

  Expand all

  object

  Id

  integer

  format: int16

  1 - RFID card standard format; 2 - RFID card reversed format; 3 - User account ID by IEC1518; 4 - Vehicle ID by IEC1518; 5 - EVCOID Vehicle contract ID by IEC1518; 6 - ISO7812 Credit Card ID; 7 - Credit Card Transaction ID; 8 - Mobile application; 9 - Web application; 10 - Local ID generated by charge point; 11 - Local ID - no format defined; 12 - Phone number for SMS authentication; 13 - Backend operator ID; 14 - PIN code; 15 - Roaming API; 16 - RFID card encrypted SHA-1; 17 - RFID card encrypted SHA-2; 18 - RFID card encrypted MD5

  Title

  string

  Title of the identification type.

  Additional properties are allowed.

  CardTypeId

  integer

  format: int32

  Enumeration is defined by instance operator. Please check catc types under CRM->Identifications.

  Number

  string

  External identification code(number written on identification card).

  Code

  string

  Unique hidden identification code (RFID card code).

  User

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the user.

  FirstName

  string

  User’s first name.

  LastName

  string

  User’s last name.

  IsCompany

  integer

  format: int16

  0 - Person; 1 - Company.

  CompanyName

  string

  User’s company name if user is company.

  Email

  string

  User’s email.

  GSMNumber

  string

  User’s mobile number.

  ExternalCode

  string

  External id of the user (normally ERP id).

  TaxNumber

  string

  User’s tax number.

  UICulture

  string

  User’s UI culture based on ISO.

  Additional properties are allowed.

  UserPayer

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the payer.

  FirstName

  string

  Payer’s first name.

  LastName

  string

  Payer’s last name.

  IsCompany

  integer

  format: int16

  0 - Person; 1 - Company.

  CompanyName

  string

  Payer’s company name if user is company.

  Email

  string

  User’s email.

  GSMNumberr

  string

  Payer’s mobile number.

  ExternalCode

  string

  External id of the payer (normally ERP id).

  TaxNumber

  string

  Payer’s tax number.

  UICulture

  string

  Payer’s UI culture based on ISO.

  Additional properties are allowed.

  UserContract

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the user contract.

  Number

  string

  Friendly ID of the user contract.

  ExternalNumber

  string

  External code of user contract. Normally is generated by ERP system and stord in Ocean.

  Type

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the user contract type. Contract types are defined by Ocean administrator. Please check CRM->Contract types to get ID's.

  Code

  string

  User contract type code.

  Title

  string

  User contract type title.

  PaymentType

  Expand all

  object

  Id

  integer

  format: int16

  1-PERUSAGE; 2-PERSESSIONQUANTATIES; 3-SUBSCRIPTION; 4-PERUSAGE; 5-PAYASYOUGO.

  Title

  string

  Title of the payment type.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Roaming

  Expand all

  object

  RoamingAuthorizationId

  string

  External id of roaming authorization as a base for charging session.

  RoamingPlatform

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform.

  Title

  string

  Roaming platform title.

  RoamingActor

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform actor/partner.

  Code

  string

  Unique code of the roaming actor on a specific platform.

  Title

  string

  Title of roaming actor on specific platform.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  PurchasePreauthorization

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the Purchase Preauthorization linked with session.

  PayInMethod

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the PayInMethod linked with session.

  Alias

  string

  String associated with the PayInMethod linked with session.

  MethodTypeId

  integer

  format: int64

  Unique ID of the PayInMethod Type.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ChargingSessionId": 660427,
    "ChargingSessionNumber": "S-2023/2673",
    "ChargingSessionSourceId": 1,
    "ParkingFrom": null,
    "ParkingTo": null,
    "ConnectedFrom": "2023-10-30T07: 53: 03.557Z",
    "ConnectedTo": null,
    "ChargingFrom": "2023-10-30T07: 53: 03.557Z",
    "ChargingTo": null,
    "MeterStart": 6804.3,
    "MeterEnd": null,
    "ActiveEnergyConsumption": null,
    "MaxActivePower": null,
    "RoamingTypeId": 0,
    "RoamingSessionId": null,
    "InstanceRoamingPlatformId": null,
    "ChargingSessionStopReasonId": null,
    "Evse": {
      "Id": 75691,
      "EvseFriendlyCode": "1",
      "ChargingTypeId": 1,
      "OutMaxPower": 22.08,
      "NumberOfPhases": 3,
      "ExternalCode": null,
      "PaymentRequired": 0,
      "Connector": {
        "Id": 90513,
        "FriendlyCode": "1",
        "ConnectorTypeId": 1
      },
      "ChargePoint": {
        "Id": 7303,
        "FriendlyCode": "09",
        "ExternalCode": null,
        "SerialNumber": "SI*HW0007-02"
      },
      "Owner": {
        "Id": 1,
        "Name": "Etrel d.o.o.",
        "AccountingSystemCode": "EXt"
      },
      "Location": {
        "LocationId": 40,
        "FriendlyName": "Davorin development",
        "FriendlyCode": "SI06-00092",
        "LocationTypeId": 11,
        "LocationAccessTypeId": 1
      },
      "Address": {
        "StreetName": "Pod jelšami",
        "HouseNumber": "6",
        "CityName": "Grosuplje",
        "PostNumber": "1290",
        "CountryCode": "SI"
      },
      "Roaming": {
        "RoamingPlatform": {
          "Id": null,
          "Title": null,
          "RoamingActor": {
            "Id": null,
            "Code": null,
            "Title": null
          }
        }
      }
    },
    "ChargingAuthorization": {
      "Id": 837519,
      "Number": "A-2023/4726",
      "AuthorizationSourceId": 1,
      "ServerReceivedTimestamp": "2023-10-30T07: 53: 03.950Z",
      "Payable": 0,
      "Identification": {
        "Id": 20504,
        "IdentificationType": {
          "Id": 14,
          "Title": "PIN code"
        },
        "CardTypeId": 14,
        "Number": "#2",
        "Code": "#1111",
        "User": {
          "Id": 7361,
          "FirstName": "Jasmin",
          "LastName": "Tester",
          "IsCompany": 0,
          "CompanyName": "",
          "Email": "jasmin.botonjic.driver.test@int.etrel.com",
          "GSMNumber": "",
          "ExternalCode": null,
          "TaxNumber": null,
          "UICulture": "en-GB"
        },
        "UserPayer": {
          "Id": 6861,
          "FirstName": "Jasmin",
          "LastName": "Tester",
          "IsCompany": 0,
          "CompanyName": "",
          "Email": "jasmin.botonjic.driver.test@int.etrel.com",
          "GSMNumberr": "",
          "ExternalCode": null,
          "TaxNumber": null,
          "UICulture": "en-GB"
        },
        "UserContract": {
          "Id": 4374,
          "Number": "C-2021/126",
          "ExternalNumber": null,
          "Type": {
            "Id": 48,
            "Code": "TEST_SUBSCRIBER",
            "Title": "Test Subscriber",
            "PaymentType": {
              "Id": 4,
              "Title": ""
            }
          }
        }
      },
      "Roaming": {
        "RoamingAuthorizationId": null,
        "RoamingPlatform": {
          "Id": null,
          "Title": null,
          "RoamingActor": {
            "Id": null,
            "Code": null,
            "Title": null
          }
        }
      },
      "PurchasePreauthorization": {
        "Id": null,
        "PayInMethod": {
          "Id": null,
          "Alias": null,
          "MethodTypeId": null
        }
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.started.user

  When system receives from charger that sessions has started. In this case smaller object is send.

  Operation ID{API_ACCESS_KEY}.*.session.started.user

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Started User

  • application/json

  Payload

  Expand all

  object

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  LocationId

  integer

  format: int32

  Unique ID of the charging location.

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  RoamingTypeId

  integer

  format: int16

  0 - Local sessions (Our users on our infrastructure); 1 - CPO (Others roaming on our infrastructure); 2 - EMSP (Our users on roaming infractructure); 3 - CPO&EMSP (Our users roaming or other users roaming on our infrastructure).

  ChargingFrom

  string

  format: date-time

  Charging start time.

  ChargingTo

  string

  format: date-time

  Charging end time.

  MeterStart

  string

  format: date-time

  Meter value at session start. Depends on the charger if meter values is reset for each charging.

  MeterEnd

  string

  format: date-time

  Meter value at session end. Depends on the charger if meter values is reset for each charging.

  ActiveEnergyConsumption

  number

  format: float

  Active energy consumption during charging (kWh).

  MaxActivePower

  number

  format: float

  Max measured power during charging (kW).

  ChargingSessionStopReasonId

  integer

  format: int16

  1 - Local stop; 2 - Remote stop by user; 3 - Emergency stop; 4 - Energy limit reached; 5 - EV disconnected; 6 - Deauthorized; 7 - Immediate reset; 8 - Local out of credit; 9 - Local reboot; 10 - Power loss; 11 - Power quality; 12 - SOC limit reached; 13 - Time limit reached; 14 - Unlock command; 15 - Other; 16 - Finished in back office at next session start; 17 - Finished in back office with availability changed event; 18 - Remote stop by operator; 19 - Error occured during charging; 20 - No more funds - charging time expired; 21 - No more funds - energy consumption reached.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ChargingSessionId": 0,
    "LocationId": 0,
    "InstanceId": 0,
    "UserId": 0,
    "RoamingTypeId": 0,
    "ChargingFrom": "2019-08-24T14:15:22Z",
    "ChargingTo": "2019-08-24T14:15:22Z",
    "MeterStart": "2019-08-24T14:15:22Z",
    "MeterEnd": "2019-08-24T14:15:22Z",
    "ActiveEnergyConsumption": 0.1,
    "MaxActivePower": 0.1,
    "ChargingSessionStopReasonId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.ended

  When system receives from charger that sessions has ended.

  Operation ID{API_ACCESS_KEY}.*.session.ended

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Ended

  • application/json

  Payload

  Expand all

  object

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  ChargingSessionNumber

  string

  Friendly ID of the charging session

  ChargingSessionSourceId

  integer

  format: int16

  1 - Local charge point (CSO); 2 - Roaming CDR.

  ParkingFrom

  string

  format: date-time

  Parking start time. Normally empty if charger is not able to detect parking time.

  ParkingTo

  string

  format: date-time

  Parking end time. Normally empty if charger is not able to detect parking time.

  ConnectedFrom

  string

  format: date-time

  Connected from time. If system is not able to detect when vehicle was connected then connected start time is the same as the charging start time.

  ConnectedTo

  string

  format: date-time

  Connected to time. If system is not able to detect when vehicle was connected then connected to time is the same as the charging end time

  ChargingFrom

  string

  format: date-time

  Charging start time.

  ChargingTo

  string

  format: date-time

  Charging end time.

  MeterStart

  string

  format: date-time

  Meter value at session start. Depends on the charger if meter values is reset for each charging.

  MeterEnd

  string

  format: date-time

  Meter value at session end. Depends on the charger if meter values is reset for each charging.

  ActiveEnergyConsumption

  number

  format: float

  Active energy consumption during charging (kWh).

  MaxActivePower

  number

  format: float

  Max measured power during charging (kW).

  RoamingTypeId

  integer

  format: int16

  0 - Local sessions (Our users on our infrastructure); 1 - CPO (Others roaming on our infrastructure); 2 - EMSP (Our users on roaming infractructure); 3 - CPO&EMSP (Our users roaming or other users roaming on our infrastructure).

  RoamingSessionId

  string

  Roaming session id, collected from roaming partner, used as reference when communicating with partner.

  InstanceRoamingPlatformId

  integer

  format: int32

  Roaming platform id.

  ChargingSessionStopReasonId

  integer

  format: int16

  1 - Local stop; 2 - Remote stop by user; 3 - Emergency stop; 4 - Energy limit reached; 5 - EV disconnected; 6 - Deauthorized; 7 - Immediate reset; 8 - Local out of credit; 9 - Local reboot; 10 - Power loss; 11 - Power quality; 12 - SOC limit reached; 13 - Time limit reached; 14 - Unlock command; 15 - Other; 16 - Finished in back office at next session start; 17 - Finished in back office with availability changed event; 18 - Remote stop by operator; 19 - Error occured during charging; 20 - No more funds - charging time expired; 21 - No more funds - energy consumption reached.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  EvseFriendlyCode

  string

  Friendly code of the Evse.

  ChargingTypeId

  integer

  format: int16

  1 - AC; 2 - DC; 3 - Wireless.

  OutMaxPower

  number

  format: float

  Max Evse power (kW).

  NumberOfPhases

  integer

  format: int16

  null - when DC or undefined; 1 - Single phase, 3 - Three phase.

  ExternalCode

  string

  PaymentRequired

  integer

  format: int16

  0 - Disabled; 1 - Enabled.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  FriendlyCode

  string

  Friendly code of the connector.

  ConnectorTypeId

  integer

  format: int16

  0 - Unknown; 1 - Type 2 socket; 2 - Type 2 Mode socked; 3 - Type 2 plug; 4 - Type 2 Mode 2 plug; 5 - CHAdeMO Plug; 6 - CCS plug; 7 - Household German Type; 8 - Type1Socket; 9 - Tesla super charger connector; 10 - Type 3 socket; 11 - Type 3 plug; 12 - IEC60309 Single Phase; 13 - IEC60309 Three Phase; 14 - Small Paddle Inductive; 15 - Large Paddle Inductive; 16 - Type1Cable.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  ExternalCode

  string

  External Evse code. Normally entered into Ocean from ERP system.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Owner

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charge point owner as business partner.

  Name

  string

  Charger owner business partner name.

  AccountingSystemCode

  string

  Charger owner business partner external code. Normally this is ERP code.

  Additional properties are allowed.

  Location

  Expand all

  object

  LocationId

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyName

  string

  Friendly name of the location.

  FriendlyCode

  string

  Friendly code of the location.

  LocationTypeId

  integer

  format: int16

  Enumeration is defined by instance operator. Please get list from location editor.

  LocationAccessTypeId

  integer

  format: int16

  1 - Public accessible - Free access; 2 - Private - only for customers; 3 - Private - only for employees; 4 - Public access - payable; 5 - Private access - home; 6 - Private access - plug sharing; 7 - Public access - car sharing; 8 - Private access - only for residents; 9 - Public in working hours and only private out of working hours.

  Additional properties are allowed.

  Address

  Expand all

  object

  StreetName

  string

  Location address (street name).

  HouseNumber

  string

  Location address (house number).

  CityName

  string

  Location address (city name).

  PostNumber

  string

  Location address (post number).

  CountryCode

  string

  Location address (country code).

  Additional properties are allowed.

  Roaming

  Expand all

  object

  RoamingPlatform

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform.

  Title

  string

  Roaming platform title.

  RoamingActor

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform actor/partner.

  Code

  string

  Unique code of the roaming actor on a specific platform.

  Title

  string

  Title of roaming actor on specific platform.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  ChargingAuthorization

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the charging authorization.

  Number

  string

  Friendly ID of the charging authorization.

  AuthorizationSourceId

  integer

  format: int16

  1 - Local charge point (CSO); 2 - Roaming live authorization request requested; 3 - Local EMSP user interface (web or mobile); 4 - Manually initiated by CSO operator; 5 - Roaming live authorization request received; 6 - Roaming remote start command send; 7 - Roaming remote start command received; 8 - Api authorization request received; 9 - Api authorization request requested; 10 - Api remote start command received

  ServerReceivedTimestamp

  string

  format: date-time

  Authorization request received timestamp.

  Payable

  integer

  format: int16

  0 - Disabled; 1 - Enabled.

  Identification

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the identification.

  IdentificationType

  Expand all

  object

  Id

  integer

  format: int16

  1 - RFID card standard format; 2 - RFID card reversed format; 3 - User account ID by IEC1518; 4 - Vehicle ID by IEC1518; 5 - EVCOID Vehicle contract ID by IEC1518; 6 - ISO7812 Credit Card ID; 7 - Credit Card Transaction ID; 8 - Mobile application; 9 - Web application; 10 - Local ID generated by charge point; 11 - Local ID - no format defined; 12 - Phone number for SMS authentication; 13 - Backend operator ID; 14 - PIN code; 15 - Roaming API; 16 - RFID card encrypted SHA-1; 17 - RFID card encrypted SHA-2; 18 - RFID card encrypted MD5

  Title

  string

  Title of the identification type.

  Additional properties are allowed.

  CardTypeId

  integer

  format: int32

  Enumeration is defined by instance operator. Please check catc types under CRM->Identifications.

  Number

  string

  External identification code(number written on identification card).

  Code

  string

  Unique hidden identification code (RFID card code).

  User

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the user.

  FirstName

  string

  User’s first name.

  LastName

  string

  User’s last name.

  IsCompany

  integer

  format: int16

  0 - Person; 1 - Company.

  CompanyName

  string

  User’s company name if user is company.

  Email

  string

  User’s email.

  GSMNumber

  string

  User’s mobile number.

  ExternalCode

  string

  External id of the user (normally ERP id).

  TaxNumber

  string

  User’s tax number.

  UICulture

  string

  User’s UI culture based on ISO.

  Additional properties are allowed.

  UserPayer

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the payer.

  FirstName

  string

  Payer’s first name.

  LastName

  string

  Payer’s last name.

  IsCompany

  integer

  format: int16

  0 - Person; 1 - Company.

  CompanyName

  string

  Payer’s company name if user is company.

  Email

  string

  User’s email.

  GSMNumberr

  string

  Payer’s mobile number.

  ExternalCode

  string

  External id of the payer (normally ERP id).

  TaxNumber

  string

  Payer’s tax number.

  UICulture

  string

  Payer’s UI culture based on ISO.

  Additional properties are allowed.

  UserContract

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the user contract.

  Number

  string

  Friendly ID of the user contract.

  ExternalNumber

  string

  External code of user contract. Normally is generated by ERP system and stord in Ocean.

  Type

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the user contract type. Contract types are defined by Ocean administrator. Please check CRM->Contract types to get ID's.

  Code

  string

  User contract type code.

  Title

  string

  User contract type title.

  PaymentType

  Expand all

  object

  Id

  integer

  format: int16

  1-PERUSAGE; 2-PERSESSIONQUANTATIES; 3-SUBSCRIPTION; 4-PERUSAGE; 5-PAYASYOUGO.

  Title

  string

  Title of the payment type.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Roaming

  Expand all

  object

  RoamingAuthorizationId

  string

  External id of roaming authorization as a base for charging session.

  RoamingPlatform

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform.

  Title

  string

  Roaming platform title.

  RoamingActor

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the roaming platform actor/partner.

  Code

  string

  Unique code of the roaming actor on a specific platform.

  Title

  string

  Title of roaming actor on specific platform.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  PurchasePreauthorization

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the Purchase Preauthorization linked with session.

  PayInMethod

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the PayInMethod linked with session.

  Alias

  string

  String associated with the PayInMethod linked with session.

  MethodTypeId

  integer

  format: int64

  Unique ID of the PayInMethod Type.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ChargingSessionId": 660427,
    "ChargingSessionNumber": "S-2023/2673",
    "ChargingSessionSourceId": 1,
    "ParkingFrom": null,
    "ParkingTo": null,
    "ConnectedFrom": "2023-10-30T07: 53: 03.557Z",
    "ConnectedTo": null,
    "ChargingFrom": "2023-10-30T07: 53: 03.557Z",
    "ChargingTo": null,
    "MeterStart": 6804.3,
    "MeterEnd": null,
    "ActiveEnergyConsumption": null,
    "MaxActivePower": null,
    "RoamingTypeId": 0,
    "RoamingSessionId": null,
    "InstanceRoamingPlatformId": null,
    "ChargingSessionStopReasonId": null,
    "Evse": {
      "Id": 75691,
      "EvseFriendlyCode": "1",
      "ChargingTypeId": 1,
      "OutMaxPower": 22.08,
      "NumberOfPhases": 3,
      "ExternalCode": null,
      "PaymentRequired": 0,
      "Connector": {
        "Id": 90513,
        "FriendlyCode": "1",
        "ConnectorTypeId": 1
      },
      "ChargePoint": {
        "Id": 7303,
        "FriendlyCode": "09",
        "ExternalCode": null,
        "SerialNumber": "SI*HW0007-02"
      },
      "Owner": {
        "Id": 1,
        "Name": "Etrel d.o.o.",
        "AccountingSystemCode": "EXt"
      },
      "Location": {
        "LocationId": 40,
        "FriendlyName": "Davorin development",
        "FriendlyCode": "SI06-00092",
        "LocationTypeId": 11,
        "LocationAccessTypeId": 1
      },
      "Address": {
        "StreetName": "Pod jelšami",
        "HouseNumber": "6",
        "CityName": "Grosuplje",
        "PostNumber": "1290",
        "CountryCode": "SI"
      },
      "Roaming": {
        "RoamingPlatform": {
          "Id": null,
          "Title": null,
          "RoamingActor": {
            "Id": null,
            "Code": null,
            "Title": null
          }
        }
      }
    },
    "ChargingAuthorization": {
      "Id": 837519,
      "Number": "A-2023/4726",
      "AuthorizationSourceId": 1,
      "ServerReceivedTimestamp": "2023-10-30T07: 53: 03.950Z",
      "Payable": 0,
      "Identification": {
        "Id": 20504,
        "IdentificationType": {
          "Id": 14,
          "Title": "PIN code"
        },
        "CardTypeId": 14,
        "Number": "#2",
        "Code": "#1111",
        "User": {
          "Id": 7361,
          "FirstName": "Jasmin",
          "LastName": "Tester",
          "IsCompany": 0,
          "CompanyName": "",
          "Email": "jasmin.botonjic.driver.test@int.etrel.com",
          "GSMNumber": "",
          "ExternalCode": null,
          "TaxNumber": null,
          "UICulture": "en-GB"
        },
        "UserPayer": {
          "Id": 6861,
          "FirstName": "Jasmin",
          "LastName": "Tester",
          "IsCompany": 0,
          "CompanyName": "",
          "Email": "jasmin.botonjic.driver.test@int.etrel.com",
          "GSMNumberr": "",
          "ExternalCode": null,
          "TaxNumber": null,
          "UICulture": "en-GB"
        },
        "UserContract": {
          "Id": 4374,
          "Number": "C-2021/126",
          "ExternalNumber": null,
          "Type": {
            "Id": 48,
            "Code": "TEST_SUBSCRIBER",
            "Title": "Test Subscriber",
            "PaymentType": {
              "Id": 4,
              "Title": ""
            }
          }
        }
      },
      "Roaming": {
        "RoamingAuthorizationId": null,
        "RoamingPlatform": {
          "Id": null,
          "Title": null,
          "RoamingActor": {
            "Id": null,
            "Code": null,
            "Title": null
          }
        }
      },
      "PurchasePreauthorization": {
        "Id": null,
        "PayInMethod": {
          "Id": null,
          "Alias": null,
          "MethodTypeId": null
        }
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.billing.user.ended

  After session user billing is successfully executed.

  Operation ID{API_ACCESS_KEY}.*.session.billing.user.ended

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session User Billing Ended

  • application/json

  Payload

  Expand all

  object

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  ChargingSessionNumber

  string

  Friendly ID of the charging session

  InstanceRoamingPlatformId

  integer

  format: int32

  Roaming platform id.

  EvseId

  integer

  format: int32

  Unique ID of the Evse.

  BillingStatusId

  integer

  format: int16

  1-Not executed yet; 2-Successfully executed; 3-Failed not enough data (energy consumption data missing); 4-Disputed by operator; 5-Skipped not enough energy consumption; 6-Skipped charging did not last enough; 7-Skipped parking did not last enough; 8-Cannot finish billing, not enough data (parking time is missing); 9-Cannot finish billing, not enough data (max measured charging power is missing); 10-Not enough funds or quantities on account; 11-Preauthorized funds smaller than actual; 12-No tariff assigned to charge point, user or roaming contract; 13-Failed, user contract or roaming contract cannot be resolved; 14-Failed, internal error; 15-Billing can not be executed for externally authorized users; 16-Payment not enabled on charge point connector; 17-Skipped fault occurred during charging; 18-Warning billing cost seems to be too high; 19-Billing skipped because charging has no end time or has last suspiciously long; 20-Billing skipped because parking has no end time or has last suspiciously long; 21-Successfully executed, but spent more then funds on account; 22-Local user has free charging.

  BillingRetries

  integer

  format: int16

  Number of billing attempts.

  BillingNextRetry

  string

  format: date-time

  Next billing attempt timestamp.

  RunnedManuallyByOperatorId

  integer

  format: int32

  Ocean unique id of the operator that manually executed billing.

  TotalCost

  number

  format: float

  Total session costs with tax.

  TotalCostWithoutTax

  number

  format: float

  Total session costs without tax.

  TotalCostTax

  number

  format: float

  Session tax

  TotalDiscount

  number

  format: float

  Session discount - other than coupon

  TotalCouponDiscount

  number

  format: float

  Session coupon discount

  MoneyTransactions

  Expand all

  array<object>

  single session can have multiple money transaction objects

  PaymentTypeId

  integer

  format: int16

  1-PERUSAGE; 2-PERSESSIONQUANTATIES; 3-SUBSCRIPTION; 4-PERUSAGE; 5-PAYASYOUGO.

  Timestamp

  string

  format: date-time

  Timestamp of money transaction.

  Direction

  string

  UP- Money refunded or topped up on account; DOWN - money decreased from account.

  Tariff

  Expand all

  object

  Id

  integer

  format: int16

  Ocean unique id of the tariff

  Title

  string

  Tariff title

  Additional properties are allowed.

  TransactionType

  Expand all

  object

  Id

  integer

  format: int16

  1-Reservation fee; 2-Access fee; 3-Parking time fee [hour]; 4-Max charging power fee; 5-Consumed energy fee; 6-Charging time fee [hour]; 7-Parking time fee [min]; 8-Charging time fee [min]; 9-Unexecuted reservation fee; 10-Monthly subscription; 11-RFID card cost; 12-Upload funds on user account.

  Title

  string

  Transaction type title.

  Unit

  string

  Transaction type unit.

  Additional properties are allowed.

  TariffTransactionTypePrice

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the tariff pricing.

  ChargingDurationLimit

  integer

  format: int16

  Defines if session should automatically stop after defined time (unit - minute).

  RepeatingAtEveryChargingMinutes

  integer

  format: int16

  Defines if price should be billed repeated every x minutes (unit - minute).

  ValidAfterChargingMinutes

  integer

  format: int16

  Defines after how many minutes prices is active (unit - minute).

  PricePerUnit

  number

  format: float

  Price per unit (unit - instance currency).

  Additional properties are allowed.

  Quantity

  number

  format: float

  Transaction billing quantity (unit is defined in object TariffTransactionTypePrice.PricePerUnit).

  Amount

  number

  format: float

  Transaction amount with tax.

  AmountWithoutTax

  number

  format: float

  Transaction amount without tax.

  CurrencyCode

  string

  Instance currency.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ChargingSessionId": 0,
    "ChargingSessionNumber": "string",
    "InstanceRoamingPlatformId": 0,
    "EvseId": 0,
    "BillingStatusId": 0,
    "BillingRetries": 0,
    "BillingNextRetry": "2019-08-24T14:15:22Z",
    "RunnedManuallyByOperatorId": 0,
    "TotalCost": 0.1,
    "TotalCostWithoutTax": 0.1,
    "TotalCostTax": 0.1,
    "TotalDiscount": 0.1,
    "TotalCouponDiscount": 0.1,
    "MoneyTransactions": [
      {
        "PaymentTypeId": 0,
        "Timestamp": "2019-08-24T14:15:22Z",
        "Direction": "string",
        "Tariff": {
          "Id": 0,
          "Title": "string"
        },
        "TransactionType": {
          "Id": 0,
          "Title": "string",
          "Unit": "string"
        },
        "TariffTransactionTypePrice": {
          "Id": 0,
          "ChargingDurationLimit": 0,
          "RepeatingAtEveryChargingMinutes": 0,
          "ValidAfterChargingMinutes": 0,
          "PricePerUnit": 0.1
        },
        "Quantity": 0.1,
        "Amount": 0.1,
        "AmountWithoutTax": 0.1,
        "CurrencyCode": "string"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.billing.b2b.ended

  After session B2B billing is successfully executed.

  Operation ID{API_ACCESS_KEY}.*.session.billing.b2b.ended

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session B2B Billing Ended

  • application/json

  Payload

  Expand all

  object

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  ChargingSessionNumber

  string

  Friendly ID of the charging session

  InstanceRoamingPlatformId

  integer

  format: int32

  Roaming platform id.

  EvseId

  integer

  format: int32

  Unique ID of the Evse.

  BillingStatusId

  integer

  format: int16

  1-Not executed yet; 2-Successfully executed; 3-Failed not enough data (energy consumption data missing); 4-Disputed by operator; 5-Skipped not enough energy consumption; 6-Skipped charging did not last enough; 7-Skipped parking did not last enough; 8-Cannot finish billing, not enough data (parking time is missing); 9-Cannot finish billing, not enough data (max measured charging power is missing); 10-Not enough funds or quantities on account; 11-Preauthorized funds smaller than actual; 12-No tariff assigned to charge point, user or roaming contract; 13-Failed, user contract or roaming contract cannot be resolved; 14-Failed, internal error; 15-Billing can not be executed for externally authorized users; 16-Payment not enabled on charge point connector; 17-Skipped fault occurred during charging; 18-Warning billing cost seems to be too high; 19-Billing skipped because charging has no end time or has last suspiciously long; 20-Billing skipped because parking has no end time or has last suspiciously long; 21-Successfully executed, but spent more then funds on account; 22-Local user has free charging.

  BillingRetries

  integer

  format: int16

  Number of billing attempts.

  BillingNextRetry

  string

  format: date-time

  Next billing attempt timestamp.

  RunnedManuallyByOperatorId

  integer

  format: int32

  Ocean unique id of the operator that manually executed billing.

  TotalCost

  number

  format: float

  Total session costs with tax.

  TotalCostWithoutTax

  number

  format: float

  Total session costs without tax.

  TotalCostTax

  number

  format: float

  Session tax

  TotalDiscount

  number

  format: float

  Session discount - other than coupon

  TotalCouponDiscount

  number

  format: float

  Session coupon discount

  MoneyTransactions

  Expand all

  array<object>

  single session can have multiple money transaction objects

  PaymentTypeId

  integer

  format: int16

  1-PERUSAGE; 2-PERSESSIONQUANTATIES; 3-SUBSCRIPTION; 4-PERUSAGE; 5-PAYASYOUGO.

  Timestamp

  string

  format: date-time

  Timestamp of money transaction.

  Direction

  string

  UP- Money refunded or topped up on account; DOWN - money decreased from account.

  Tariff

  Expand all

  object

  Id

  integer

  format: int16

  Ocean unique id of the tariff

  Title

  string

  Tariff title

  Additional properties are allowed.

  TransactionType

  Expand all

  object

  Id

  integer

  format: int16

  1-Reservation fee; 2-Access fee; 3-Parking time fee [hour]; 4-Max charging power fee; 5-Consumed energy fee; 6-Charging time fee [hour]; 7-Parking time fee [min]; 8-Charging time fee [min]; 9-Unexecuted reservation fee; 10-Monthly subscription; 11-RFID card cost; 12-Upload funds on user account.

  Title

  string

  Transaction type title.

  Unit

  string

  Transaction type unit.

  Additional properties are allowed.

  TariffTransactionTypePrice

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the tariff pricing.

  ChargingDurationLimit

  integer

  format: int16

  Defines if session should automatically stop after defined time (unit - minute).

  RepeatingAtEveryChargingMinutes

  integer

  format: int16

  Defines if price should be billed repeated every x minutes (unit - minute).

  ValidAfterChargingMinutes

  integer

  format: int16

  Defines after how many minutes prices is active (unit - minute).

  PricePerUnit

  number

  format: float

  Price per unit (unit - instance currency).

  Additional properties are allowed.

  Quantity

  number

  format: float

  Transaction billing quantity (unit is defined in object TariffTransactionTypePrice.PricePerUnit).

  Amount

  number

  format: float

  Transaction amount with tax.

  AmountWithoutTax

  number

  format: float

  Transaction amount without tax.

  CurrencyCode

  string

  Instance currency.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ChargingSessionId": 0,
    "ChargingSessionNumber": "string",
    "InstanceRoamingPlatformId": 0,
    "EvseId": 0,
    "BillingStatusId": 0,
    "BillingRetries": 0,
    "BillingNextRetry": "2019-08-24T14:15:22Z",
    "RunnedManuallyByOperatorId": 0,
    "TotalCost": 0.1,
    "TotalCostWithoutTax": 0.1,
    "TotalCostTax": 0.1,
    "TotalDiscount": 0.1,
    "TotalCouponDiscount": 0.1,
    "MoneyTransactions": [
      {
        "PaymentTypeId": 0,
        "Timestamp": "2019-08-24T14:15:22Z",
        "Direction": "string",
        "Tariff": {
          "Id": 0,
          "Title": "string"
        },
        "TransactionType": {
          "Id": 0,
          "Title": "string",
          "Unit": "string"
        },
        "TariffTransactionTypePrice": {
          "Id": 0,
          "ChargingDurationLimit": 0,
          "RepeatingAtEveryChargingMinutes": 0,
          "ValidAfterChargingMinutes": 0,
          "PricePerUnit": 0.1
        },
        "Quantity": 0.1,
        "Amount": 0.1,
        "AmountWithoutTax": 0.1,
        "CurrencyCode": "string"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.manuallyChanged

  After operator manually changes charging session data.

  Operation ID{API_ACCESS_KEY}.*.session.manuallyChanged

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Data Manually Changed

  • application/json

  Payload

  Expand all

  object

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  ChargingSessionStatusId

  integer

  format: int16

  1-Charging has started; 2-Charging in progress; 3-Charging finished - error occurred during charging; 4-Charging paused - power management; 5-Charging paused - maintenance; 6-Charging finished - ended by operator; 7-Charging finished abnormally - ocean has finished session; 8-Charging finished normally; 9-Charging started with failed authorization; 10-Charging finished, based on failed authorization; 11-Session data changed by operator; 12-Session totally disputed - costs where disputed.

  ConnectedFrom

  string

  format: date-time

  Connected from time. If system is not able to detect when vehicle was connected then connected start time is the same as the charging start time.

  ConnectedTo

  string

  format: date-time

  Connected to time. If system is not able to detect when vehicle was connected then connected to time is the same as the charging end time

  ChargingFrom

  string

  format: date-time

  Charging start time.

  ChargingTo

  string

  format: date-time

  Charging end time.

  TimeSpentCharging

  number

  format: float

  Charging duration (unit-h)

  MeterStart

  number

  format: float

  Meter value at session start. Depends on the charger if meter values is reset for each charging.

  MeterEnd

  number

  format: float

  Meter value at session end. Depends on the charger if meter values is reset for each charging.

  ActiveEnergyConsumption

  number

  format: float

  Active energy consumption during charging (kWh).

  ChargingSessionStopReasonId

  integer

  format: int16

  1 - Local stop; 2 - Remote stop by user; 3 - Emergency stop; 4 - Energy limit reached; 5 - EV disconnected; 6 - Deauthorized; 7 - Immediate reset; 8 - Local out of credit; 9 - Local reboot; 10 - Power loss; 11 - Power quality; 12 - SOC limit reached; 13 - Time limit reached; 14 - Unlock command; 15 - Other; 16 - Finished in back office at next session start; 17 - Finished in back office with availability changed event; 18 - Remote stop by operator; 19 - Error occured during charging; 20 - No more funds - charging time expired; 21 - No more funds - energy consumption reached.

  ChangeReason

  string

  Operator description why data was changed.

  UpdatedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator that did change.

  RerunBilling

  boolean

  Option to rerun billing.

  DisputeInvoice

  boolean

  Option to dispute invoice.

  CreateNewInvoice

  boolean

  Option to create new invoice.

  TransferDisputeTransactionsToNextBillingPeriod

  boolean

  Option to transfer dispute transactions to next billing period.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ChargingSessionId": 0,
    "ChargingSessionStatusId": 0,
    "ConnectedFrom": "2019-08-24T14:15:22Z",
    "ConnectedTo": "2019-08-24T14:15:22Z",
    "ChargingFrom": "2019-08-24T14:15:22Z",
    "ChargingTo": "2019-08-24T14:15:22Z",
    "TimeSpentCharging": 0.1,
    "MeterStart": 0.1,
    "MeterEnd": 0.1,
    "ActiveEnergyConsumption": 0.1,
    "ChargingSessionStopReasonId": 0,
    "ChangeReason": "string",
    "UpdatedByOperatorId": 0,
    "RerunBilling": true,
    "DisputeInvoice": true,
    "CreateNewInvoice": true,
    "TransferDisputeTransactionsToNextBillingPeriod": true
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.session.disputed

  When operator or API disputes charging session. This usually happens when costs are too high, customer was not satisfied with service or there is a mistake in data. At session dispute system deletes old session and creates a new one, referenced to the old one.

  Operation ID{API_ACCESS_KEY}.session.disputed

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Charging Session

  Accepts the following message:

  Charging Session Disputed

  • application/json

  Payload

  Expand all

  object

  ChargingSessionId

  integer

  format: int32

  Unique ID of the charging session

  DisputeType

  integer

  format: int16

  1-remove session from the system and remove costs; 2-dispute only session costs; 3-rerun billing (this one is no longer called from this SP , but from ManualyUpdate).

  DisputeInvoice

  integer

  format: int16

  Defines if session dispute also disputes invoice (it it exist of course).

  Timestamp

  string

  format: date-time

  Timestamp of dispute action.

  DisputeDescription

  string

  Operator description of session dispute.

  DisputedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who have initiated dispute.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ChargingSessionId": 0,
    "DisputeType": 0,
    "DisputeInvoice": 0,
    "Timestamp": "2019-08-24T14:15:22Z",
    "DisputeDescription": "string",
    "DisputedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.measurementsChanged

  When measurements are stored into the Ocean.

  Operation ID{API_ACCESS_KEY}.*.session.measurementsChanged

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Measurement Changed

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  ChargePointId

  integer

  format: int32

  Unique ID of the charger.

  ConnectorId

  integer

  format: int32

  Unique ID of the connector.

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  Measurements

  Expand all

  array<object>

  Collection of one or more sampled values.

  Type

  string

  Options - ActivePower, EnergyConsumed, CurrentL1, CurrentL2, CurrentL3, DCcurrent, StateOfCharge, PowerFactorL1, PowerFactorL2, PowerFactorL3, PowerFactor, ACvoltageL1, ACvoltageL2, ACvoltageL3, ACcurrentOffered, PowerL1, PowerL2, PowerL3, Unknown.

  Value

  number

  format: float

  Sampled value.

  Timestamp

  string

  format: date-time

  Timestamp for measured value(s).

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "ChargePointId": 0,
    "ConnectorId": 0,
    "ChargingSessionId": 0,
    "Measurements": [
      {
        "Type": "string",
        "Value": 0.1,
        "Timestamp": "2019-08-24T14:15:22Z"
      }
    ]
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.vehicle80PercentFull

  When EV battery is 80% full. This message is triggered only on connector reporting SOC.

  Operation ID{API_ACCESS_KEY}.*.session.vehicle80PercentFull

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Vehicle Is 80 Percent Full

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  ChargingSession

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging session

  ActiveEnergyConsumed

  number

  format: float

  Active energy consumption during charging (kWh).

  StateOfCharge

  number

  format: float

  State Of Charge.

  Additional properties are allowed.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "ChargingSession": {
      "Id": 0,
      "ActiveEnergyConsumed": 0.1,
      "StateOfCharge": 0.1
    },
    "Evse": {
      "Id": 0,
      "Connector": {
        "Id": 0
      },
      "ChargePoint": {
        "Id": 0
      },
      "Location": {
        "Id": 0
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.vehicleFull

  When detected that user vehicle is full (SOC 100% or Power almost 0 for a longer time).

  Operation ID{API_ACCESS_KEY}.*.session.vehicleFull

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Vehicle Is Full

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  ChargingSession

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging session

  ActiveEnergyConsumed

  number

  format: float

  Active energy consumption during charging (kWh).

  StateOfCharge

  number

  format: float

  State Of Charge.

  Additional properties are allowed.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "ChargingSession": {
      "Id": 0,
      "ActiveEnergyConsumed": 0.1,
      "StateOfCharge": 0.1
    },
    "Evse": {
      "Id": 0,
      "Connector": {
        "Id": 0
      },
      "ChargePoint": {
        "Id": 0
      },
      "Location": {
        "Id": 0
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.ended.regulary

  When connector status changes from one of the charging status (Charging, PausedByEV, PausedByEVSE) to Available or Finishing and local EMSP user is charging.

  Operation ID{API_ACCESS_KEY}.*.session.ended.regulary

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Ended Regulary

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  ChargingSessionId

  integer

  format: int32

  Unique ID of the charging session

  ChargingSessionActiveEnergyConsumed

  number

  format: float

  Active energy consumption during charging (kWh).

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "ChargingSessionId": 0,
    "ChargingSessionActiveEnergyConsumed": 0.1
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.ended.fault

  When connector status changes from one of the charging status (Charging, PausedByEV, PausedByEVSE) to Fault and local EMSP user is charging.

  Operation ID{API_ACCESS_KEY}.*.session.ended.fault

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Ended With Fault

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  ChargingSessionId

  integer

  format: int32

  Unique ID of the charging session

  ChargingSessionActiveEnergyConsumed

  number

  format: float

  Active energy consumption during charging (kWh).

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "ChargingSessionId": 0,
    "ChargingSessionActiveEnergyConsumed": 0.1
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.reservation.created

  When EV user successfully posts new reservation.

  Operation ID{API_ACCESS_KEY}.*.reservation.created

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Reservation Created

  • application/json

  Payload

  Expand all

  object

  ReervationId

  integer

  format: int32

  Ocean unique id of the charging reservation.

  Number

  string

  Ocean friendly id of the charging reservation.

  User

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  ExternalCode

  string

  External id of the user (normally ERP id).

  Additional properties are allowed.

  PlannedFrom

  string

  format: date-time

  Reservation planned start.

  PlannedTo

  string

  format: date-time

  Reservation planned stop.

  ReservationSource

  Expand all

  object

  Id

  integer

  format: int16

  0-Local sessions - Our users on our infrastructure; 1-CPO - others roaming on our infrastructure; 2-EMSP - our users on roaming infractructure; 3-CPO&EMSP - our users roaming or other users roaming on our infrastructure

  Title

  string

  Reservation source title.

  Additional properties are allowed.

  Roaming

  Expand all

  object

  Type

  Expand all

  object

  Id

  integer

  format: int16

  0-Local sessions - Our users on our infrastructure; 1-CPO - others roaming on our infrastructure; 2-EMSP - our users on roaming infractructure; 3-CPO&EMSP - our users roaming or other users roaming on our infrastructure

  Title

  string

  Reservation type title.

  Additional properties are allowed.

  RoamingActor

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the roaming platform actor/partner.

  Code

  string

  Unique code of the roaming actor on a specific platform.

  Additional properties are allowed.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  CityName

  string

  PostNumber

  string

  StreetName

  string

  HouseNumber

  string

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  FriendlyCode

  string

  Friendly code of the EVSE.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  FriendlyCode

  string

  Friendly code of the connector.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ReervationId": 0,
    "Number": "string",
    "User": {
      "Id": 0,
      "Email": "string",
      "ExternalCode": "string"
    },
    "PlannedFrom": "2019-08-24T14:15:22Z",
    "PlannedTo": "2019-08-24T14:15:22Z",
    "ReservationSource": {
      "Id": 0,
      "Title": "string"
    },
    "Roaming": {
      "Type": {
        "Id": 0,
        "Title": "string"
      },
      "RoamingActor": {
        "Id": 0,
        "Code": "string"
      }
    },
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "CityName": "string",
      "PostNumber": "string",
      "StreetName": "string",
      "HouseNumber": "string",
      "ChargePoint": {
        "Id": 0,
        "FriendlyCode": "string",
        "SerialNumber": "string",
        "ExternalCode": "string",
        "Evse": {
          "Id": 0,
          "FriendlyCode": "string",
          "ExternalCode": "string",
          "Connector": {
            "Id": 0,
            "FriendlyCode": "string"
          }
        }
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.reservation.canceled

  When EV user successfully cancels upcoming reservation.

  Operation ID{API_ACCESS_KEY}.*.reservation.canceled

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Reservation Canceled

  • application/json

  Payload

  Expand all

  object

  ReervationId

  integer

  format: int32

  Ocean unique id of the charging reservation.

  Number

  string

  Ocean friendly id of the charging reservation.

  User

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  ExternalCode

  string

  External id of the user (normally ERP id).

  Additional properties are allowed.

  PlannedFrom

  string

  format: date-time

  Reservation planned start.

  PlannedTo

  string

  format: date-time

  Reservation planned stop.

  ReservationSource

  Expand all

  object

  Id

  integer

  format: int16

  0-Local sessions - Our users on our infrastructure; 1-CPO - others roaming on our infrastructure; 2-EMSP - our users on roaming infractructure; 3-CPO&EMSP - our users roaming or other users roaming on our infrastructure

  Title

  string

  Reservation source title.

  Additional properties are allowed.

  Roaming

  Expand all

  object

  Type

  Expand all

  object

  Id

  integer

  format: int16

  0-Local sessions - Our users on our infrastructure; 1-CPO - others roaming on our infrastructure; 2-EMSP - our users on roaming infractructure; 3-CPO&EMSP - our users roaming or other users roaming on our infrastructure

  Title

  string

  Reservation type title.

  Additional properties are allowed.

  RoamingActor

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the roaming platform actor/partner.

  Code

  string

  Unique code of the roaming actor on a specific platform.

  Additional properties are allowed.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  CityName

  string

  PostNumber

  string

  StreetName

  string

  HouseNumber

  string

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  FriendlyCode

  string

  Friendly code of the EVSE.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  FriendlyCode

  string

  Friendly code of the connector.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ReervationId": 0,
    "Number": "string",
    "User": {
      "Id": 0,
      "Email": "string",
      "ExternalCode": "string"
    },
    "PlannedFrom": "2019-08-24T14:15:22Z",
    "PlannedTo": "2019-08-24T14:15:22Z",
    "ReservationSource": {
      "Id": 0,
      "Title": "string"
    },
    "Roaming": {
      "Type": {
        "Id": 0,
        "Title": "string"
      },
      "RoamingActor": {
        "Id": 0,
        "Code": "string"
      }
    },
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "CityName": "string",
      "PostNumber": "string",
      "StreetName": "string",
      "HouseNumber": "string",
      "ChargePoint": {
        "Id": 0,
        "FriendlyCode": "string",
        "SerialNumber": "string",
        "ExternalCode": "string",
        "Evse": {
          "Id": 0,
          "FriendlyCode": "string",
          "ExternalCode": "string",
          "Connector": {
            "Id": 0,
            "FriendlyCode": "string"
          }
        }
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.reservation.timeChanged

  When customer or operator changes reservation time.

  Operation ID{API_ACCESS_KEY}.*.reservation.timeChanged

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Reservation Time Changed

  • application/json

  Payload

  Expand all

  object

  ReervationId

  integer

  format: int32

  Ocean unique id of the charging reservation.

  Number

  string

  Ocean friendly id of the charging reservation.

  User

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  ExternalCode

  string

  External id of the user (normally ERP id).

  Additional properties are allowed.

  PlannedFrom

  string

  format: date-time

  Reservation planned start.

  PlannedTo

  string

  format: date-time

  Reservation planned stop.

  ReservationSource

  Expand all

  object

  Id

  integer

  format: int16

  0-Local sessions - Our users on our infrastructure; 1-CPO - others roaming on our infrastructure; 2-EMSP - our users on roaming infractructure; 3-CPO&EMSP - our users roaming or other users roaming on our infrastructure

  Title

  string

  Reservation source title.

  Additional properties are allowed.

  Roaming

  Expand all

  object

  Type

  Expand all

  object

  Id

  integer

  format: int16

  0-Local sessions - Our users on our infrastructure; 1-CPO - others roaming on our infrastructure; 2-EMSP - our users on roaming infractructure; 3-CPO&EMSP - our users roaming or other users roaming on our infrastructure

  Title

  string

  Reservation type title.

  Additional properties are allowed.

  RoamingActor

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the roaming platform actor/partner.

  Code

  string

  Unique code of the roaming actor on a specific platform.

  Additional properties are allowed.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  CityName

  string

  PostNumber

  string

  StreetName

  string

  HouseNumber

  string

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  FriendlyCode

  string

  Friendly code of the EVSE.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  FriendlyCode

  string

  Friendly code of the connector.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "ReervationId": 0,
    "Number": "string",
    "User": {
      "Id": 0,
      "Email": "string",
      "ExternalCode": "string"
    },
    "PlannedFrom": "2019-08-24T14:15:22Z",
    "PlannedTo": "2019-08-24T14:15:22Z",
    "ReservationSource": {
      "Id": 0,
      "Title": "string"
    },
    "Roaming": {
      "Type": {
        "Id": 0,
        "Title": "string"
      },
      "RoamingActor": {
        "Id": 0,
        "Code": "string"
      }
    },
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "CityName": "string",
      "PostNumber": "string",
      "StreetName": "string",
      "HouseNumber": "string",
      "ChargePoint": {
        "Id": 0,
        "FriendlyCode": "string",
        "SerialNumber": "string",
        "ExternalCode": "string",
        "Evse": {
          "Id": 0,
          "FriendlyCode": "string",
          "ExternalCode": "string",
          "Connector": {
            "Id": 0,
            "FriendlyCode": "string"
          }
        }
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.session.preference.changed

  When customer or operator changes charging session preferences.

  Operation ID{API_ACCESS_KEY}.*.session.preference.changed

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Charging Session

  Accepts the following message:

  Charging Session Preference Changed

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  ChargePointId

  integer

  format: int32

  Unique ID of the charger.

  EvseId

  integer

  format: int32

  Unique ID of the Evse.

  ConnectorId

  integer

  format: int32

  Unique ID of the connector.

  ConnectorProtocolCode

  string

  Connector Protocol Code.

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  Timestamp

  string

  format: date-time

  Timestamp of collected charging preference information.

  PlannedDepartureTime

  string

  format: date-time

  Timestamp when user is planning to leave.

  SelectedChargingMode

  string

  Options - Fast, Smart.

  NumberOfPhases

  integer

  format: int16

  null - when DC or undefined; 1-Single phase; 3-Three phase.

  MinCurrent

  number

  format: float

  Minimum charging current - based on EV and EVSE properties.

  MaxCurrent

  number

  format: float

  Maximum charging current - based on EV and EVSE properties.

  RequestedEnergy

  number

  format: float

  Requested energy - by user or vehicle.

  BatteryCapacity

  number

  format: float

  Vehicle battery capacity - if known.

  StateOfCharge

  number

  format: float

  Battery status when connected - if known.

  AllowPowerManagement

  integer

  format: int16

  null - unknwon; 0-user does not allow power mgm; 1 - user allows power mgm

  AllowDischarging

  integer

  format: int16

  null - unknwon; 0-user does not allow power mgm; 1 - user allows power mgm.

  PreferenceSource

  string

  Defines from which source planned departure time has been inserted - Driver, Calculated, Vehicle.

  PreferenceRequestedEnergySource

  string

  Defines from which source requested energy has been inserted - Driver, Calculated, Vehicle.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  IdentificationId

  integer

  format: int32

  Ocean unique id of the identification used by user.

  UserChargingDurationLimit

  number

  format: float

  Maximum charging duration.

  UserChargingEnergyLimit

  number

  format: float

  Maximum charging Energy consumed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "ChargePointId": 0,
    "EvseId": 0,
    "ConnectorId": 0,
    "ConnectorProtocolCode": "string",
    "ChargingSessionId": 0,
    "Timestamp": "2019-08-24T14:15:22Z",
    "PlannedDepartureTime": "2019-08-24T14:15:22Z",
    "SelectedChargingMode": "string",
    "NumberOfPhases": 0,
    "MinCurrent": 0.1,
    "MaxCurrent": 0.1,
    "RequestedEnergy": 0.1,
    "BatteryCapacity": 0.1,
    "StateOfCharge": 0.1,
    "AllowPowerManagement": 0,
    "AllowDischarging": 0,
    "PreferenceSource": "string",
    "PreferenceRequestedEnergySource": "string",
    "UserId": 0,
    "IdentificationId": 0,
    "UserChargingDurationLimit": 0.1,
    "UserChargingEnergyLimit": 0.1
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.invoice.user.ready

  When Ocean generates invoice documents or when they are uploaded to Ocean.

  Operation ID{API_ACCESS_KEY}.invoice.user.ready

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Billing

  Accepts the following message:

  Invoice Document Ready

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  InvoiceId

  integer

  format: int32

  Ocean instance id. Every tenant has unique id.

  OceanInvoiceId

  string

  Friendly ID of the invoice.

  ExternalInvoiceId

  string

  External invoice Id.

  InvoiceTypeId

  integer

  format: int32

  Ocean instance id. Every tenant has unique id.

  InvoicePeriodFrom

  string

  format: date-time

  Invoice period from.

  InvoicePeriodTo

  string

  format: date-time

  Invoice period to.

  ChargingSession

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the charging session

  ChargingFrom

  string

  format: date-time

  Session start time.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "InvoiceId": 0,
    "OceanInvoiceId": "string",
    "ExternalInvoiceId": "string",
    "InvoiceTypeId": 0,
    "InvoicePeriodFrom": "2019-08-24T14:15:22Z",
    "InvoicePeriodTo": "2019-08-24T14:15:22Z",
    "ChargingSession": {
      "Id": 0,
      "ChargingFrom": "2019-08-24T14:15:22Z"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{invoiceTypeId}.{invoiceTemplateId}.documentGenerationPending

  • When Ad-hoc session payment is executed
  • when session is disputed and new dispute invoice needs be be generated
  • when duplicate invoice generation is triggered by operator
  • when operator manually creates new invoice
  • when monthly subscription service is regularly generating subscription invoices

  Operation ID{API_ACCESS_KEY}.*.*.documentGenerationPending

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  invoiceTypeId

  required

  integer

  format: int32

  Invoice type ID. Every invoice type has a unique ID.

  invoiceTemplateId

  required

  integer

  format: int32

  Invoice template ID. Every invoice template has a unique ID.

  • #Billing

  Accepts the following message:

  Invoice Document Pending To Be Generated

  • application/json

  Payload

  Expand all

  object

  InvoiceId

  integer

  format: int32

  Ocean instance id. Every tenant has unique id.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InvoiceId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.invoicesPeriodic.published

  When operator triggers publishing monthly subscriptions or generation of post-payment invoices.

  Operation ID{API_ACCESS_KEY}.invoicesPeriodic.published

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Billing

  Accepts the following message:

  Invoices Periodic Published

  • application/json

  Payload

  Expand all

  object

  InvoiceId

  integer

  format: int32

  Ocean instance id. Every tenant has unique id.

  BillingPeriodId

  integer

  format: int32

  Ocean billing period unique id.

  BillingPeriodFrom

  string

  format: date-time

  Billing period start time.

  BillingPeriodTo

  string

  format: date-time

  Billing period end time.

  PaymentTypeId

  integer

  format: int16

  1-Topup funds and pay per usage; 2-Topup quantaties and pay per usage; 3-Monthly payment subscription package; 4-Monthly payment pay per usage; 5-Pay as you go.

  InvoiceTypeId

  integer

  format: int16

  1-Postpayment monthly invoice; 2-User account top invoice; 3-Single session invoice based on preauthorization; 4-Single reservation invoice based on preauthorization; 5-Purchase of RFID prepayment cards; 6-Pay as you Go monthly subscription.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InvoiceId": 0,
    "BillingPeriodId": 0,
    "BillingPeriodFrom": "2019-08-24T14:15:22Z",
    "BillingPeriodTo": "2019-08-24T14:15:22Z",
    "PaymentTypeId": 0,
    "InvoiceTypeId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.helpdesk.ticket.raisedByUser

  When connector status changes.

  Operation ID{API_ACCESS_KEY}.helpdesk.ticket.raisedByUser

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Support

  Accepts the following message:

  Help Desk Ticket User Raised

  • application/json

  Payload

  Expand all

  object

  UserRequestId

  integer

  format: int64

  Ocean unique id of user request.

  Number

  string

  Ocean friendly id of the user request.

  UserRequestMessage

  string

  Request message, describing the context.

  ReportedBy

  Expand all

  object

  User

  Expand all

  object

  object properties will have null values if user request will not be posted by user (example would be posted by user payer).

  Id

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  ExternalCode

  string

  External id of the user (normally ERP id).

  Additional properties are allowed.

  UserPayer

  Expand all

  object

  object properties will have null values if user request will not be posted by user payer (example would be posted by user).

  Id

  integer

  format: int32

  Ocean unique id of the user payer.

  Email

  string

  User payer email.

  ExternalCode

  string

  External id of the user payer (normally ERP id).

  Additional properties are allowed.

  BusinessPartner

  Expand all

  object

  object properties will have null values if user request will not be posted by user payer (example would be posted by user).

  Id

  integer

  format: int32

  Ocean unique id of the business partner.

  CompanyName

  string

  Official name of the business partner.

  ExternalCode

  string

  External id of the business partner (normally ERP id).

  Additional properties are allowed.

  InsertedByOperator

  Expand all

  object

  object properties will have null values if user request will not be manually inserted by operator (usually operator inserts user request at telephone call).

  Id

  integer

  format: int32

  Ocean unique id of the operator.

  Email

  string

  Operator email.

  Additional properties are allowed.

  OtherContactName

  string

  Name of user reported request, if user entity dose not exists in the system (some external/unregistered users reported fault).

  OtherContactEmail

  string

  Email of user reported request, if user entity dose not exists in the system (some external/unregistered users reported fault).

  OtherContactPhone

  string

  Phone number of user reported request, if user entity dose not exists in the system (some external/unregistered users reported fault).

  Additional properties are allowed.

  RequestCategory

  Expand all

  object

  Id

  integer

  format: int32

  Ocean uniqe id of the category. You configure categories by your own in instance settings. Please check ID's there.

  Title

  string

  Title of category. You configure categories by your own in instance settings. Please check titles there.

  Additional properties are allowed.

  RequestCategoryType

  Expand all

  object

  Id

  integer

  format: int32

  Ocean uniqe id of the category type. You configure categories by your own in instance settings. Please check ID's there.

  Title

  string

  Title of category type. You configure categories by your own in instance settings. Please check titles there.

  Additional properties are allowed.

  RequestInsertChannel

  Expand all

  object

  Id

  integer

  format: int16

  1-Mobile app email; 2-Mobile app SMS; 3-Web portal - user front end; 4-Call center (telephone call); 5-Call center (email); 6-Information office (personal meeting); 7-Prepayment cards reseller.

  Title

  string

  Title of channel.

  Additional properties are allowed.

  TicketRelatedTo

  Expand all

  object

  ticket is always related to one or more entities. Entities will have property values null if not linked to ticket. Possible entities are - reservation, session, invoice, user identification, user contract, charging location.

  ChargingReservation

  Expand all

  object

  Id

  integer

  format: int64

  Ocean unique id of the charging reservation.

  Number

  string

  Ocean friendly id of the charging reservation.

  PlannedFrom

  string

  format: date-time

  Reservation planned start.

  PlannedTo

  string

  format: date-time

  Reservation planned stop.

  Additional properties are allowed.

  ChargingSession

  Expand all

  object

  Id

  integer

  format: int64

  Ocean unique id of the charging session.

  Number

  string

  Ocean friendly id of the charging session.

  ChargingFrom

  string

  format: date-time

  Session start time.

  ChargingTo

  string

  format: date-time

  Session end time.

  Additional properties are allowed.

  Invoice

  Expand all

  object

  Id

  integer

  format: int64

  Ocean unique id of the invoice.

  Number

  string

  Ocean friendly id of the invoice.

  Additional properties are allowed.

  UserIdentification

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the identification.

  Type

  Expand all

  object

  Id

  integer

  format: int16

  1-RFID card standard format; 2-RFID card reversed format; 3-User account ID by IEC1518; 4-Vehicle ID by IEC1518; 5-EVCOID Vehicle contract ID by IEC1518; 6-ISO7812 Credit Card ID; 7-Credit Card Transaction ID; 8-Mobile application; 9-Web application; 10-Local ID generated by charge point; 11-Local ID - no format defined; 12-Phone number for SMS authentication; 13-Backend operator ID; 14-PIN code; 15-Roaming API; 16-RFID card encrypted SHA-1; 17-RFID card encrypted SHA-2; 18-RFID card encrypted MD5.

  Title

  string

  Title of identification type.

  Additional properties are allowed.

  Number

  string

  External identification code (number written on identification card).

  Code

  string

  Unique hidden identification code (RFID card code).

  Additional properties are allowed.

  UserContract

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the user contract.

  Type

  Expand all

  object

  Id

  integer

  format: int16

  Ocean unique id of the user contract type. Contract types are defined by Ocean administrator. Please check CRM->Contract types to get ID's.

  Title

  string

  User contract type title.

  Additional properties are allowed.

  Code

  string

  External code of user contract. Normally is generated by ERP system and stord in Ocean.

  Additional properties are allowed.

  Location

  Expand all

  object

  ticket can be linked to one of the levels. If linked to connector then all parent objects are send location, charge point and evse.

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  CityName

  string

  Location address (city name).

  PostNumber

  string

  Location address (post number).

  StreetName

  string

  Location address (street name).

  HouseNumber

  string

  Location address (house number).

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  ExternalCode

  string

  External Charge Point code. Normally entered into Ocean from ERP system.

  ChargePointOwnerId

  integer

  format: int32

  External Charge Point code. Normally entered into Ocean from ERP system.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  FriendlyCode

  string

  Friendly code of the EVSE.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  FriendlyCode

  string

  Friendly code of the connector.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserRequestId": 0,
    "Number": "string",
    "UserRequestMessage": "string",
    "ReportedBy": {
      "User": {
        "Id": 0,
        "Email": "string",
        "ExternalCode": "string"
      },
      "UserPayer": {
        "Id": 0,
        "Email": "string",
        "ExternalCode": "string"
      },
      "BusinessPartner": {
        "Id": 0,
        "CompanyName": "string",
        "ExternalCode": "string"
      },
      "InsertedByOperator": {
        "Id": 0,
        "Email": "string"
      },
      "OtherContactName": "string",
      "OtherContactEmail": "string",
      "OtherContactPhone": "string"
    },
    "RequestCategory": {
      "Id": 0,
      "Title": "string"
    },
    "RequestCategoryType": {
      "Id": 0,
      "Title": "string"
    },
    "RequestInsertChannel": {
      "Id": 0,
      "Title": "string"
    },
    "TicketRelatedTo": {
      "ChargingReservation": {
        "Id": 0,
        "Number": "string",
        "PlannedFrom": "2019-08-24T14:15:22Z",
        "PlannedTo": "2019-08-24T14:15:22Z"
      },
      "ChargingSession": {
        "Id": 0,
        "Number": "string",
        "ChargingFrom": "2019-08-24T14:15:22Z",
        "ChargingTo": "2019-08-24T14:15:22Z"
      },
      "Invoice": {
        "Id": 0,
        "Number": "string"
      },
      "UserIdentification": {
        "Id": 0,
        "Type": {
          "Id": 0,
          "Title": "string"
        },
        "Number": "string",
        "Code": "string"
      },
      "UserContract": {
        "Id": 0,
        "Type": {
          "Id": 0,
          "Title": "string"
        },
        "Code": "string"
      },
      "Location": {
        "Id": 0,
        "FriendlyCode": "string",
        "CityName": "string",
        "PostNumber": "string",
        "StreetName": "string",
        "HouseNumber": "string",
        "ChargePoint": {
          "Id": 0,
          "FriendlyCode": "string",
          "SerialNumber": "string",
          "ExternalCode": "string",
          "ChargePointOwnerId": 0,
          "Evse": {
            "Id": 0,
            "FriendlyCode": "string",
            "ExternalCode": "string",
            "Connector": {
              "Id": 0,
              "FriendlyCode": "string"
            }
          }
        }
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.helpdesk.ticket.statusChanged

  When ticket status changes.

  Operation ID{API_ACCESS_KEY}.helpdesk.ticket.statusChanged

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Support

  Accepts the following message:

  Help Desk Ticket Status Changed

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserRequestId

  integer

  format: int64

  Ocean unique id of user request.

  PreviousUserRequestStatusId

  integer

  format: int32

  Previous ticket status

  NewUserRequestStatusId

  integer

  format: int32

  New ticket status

  ChangedByOperator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the operator that did change.

  Email

  string

  Email of the operator that did change.

  Additional properties are allowed.

  Message

  string

  Message

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserRequestId": 0,
    "PreviousUserRequestStatusId": 0,
    "NewUserRequestStatusId": 0,
    "ChangedByOperator": {
      "Id": 0,
      "Email": "string"
    },
    "Message": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.helpdesk.ticket.operatorResponded

  When operator responds to the ticket.

  Operation ID{API_ACCESS_KEY}.helpdesk.ticket.operatorResponded

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Support

  Accepts the following message:

  Help Desk Ticket Operator Responded

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Initial user Id.

  UserRequestId

  integer

  format: int64

  Ocean unique id of user request.

  UserRequestStatusId

  integer

  format: int32

  Current ticket status

  Message

  string

  Response message

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "UserRequestId": 0,
    "UserRequestStatusId": 0,
    "Message": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.maintenance.taskCreated

  When new maintenance task is created (2nd level support).

  Operation ID{API_ACCESS_KEY}.maintenance.taskCreated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Support

  Accepts the following message:

  Maintenance Task Created

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.maintenance.taskStatusChange

  When maintenance task status changes.

  Operation ID{API_ACCESS_KEY}.maintenance.taskStatusChange

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Support

  Accepts the following message:

  Maintenance Task Status Change

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  TaskId

  integer

  format: int32

  Ocean unique id of task.

  Number

  string

  Ocean friendly id of task.

  Title

  string

  Title of task.

  PreviousTaskStatus

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of previous task status.

  Title

  string

  Title of task.

  Additional properties are allowed.

  NewTaskStatus

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of new task status.

  Title

  string

  Title of new task status.

  Additional properties are allowed.

  ResponsibleOperator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of responsible operator.

  Email

  string

  Operator email.

  Additional properties are allowed.

  AssignedOperator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of assigned operator.

  Email

  string

  Operator email.

  Additional properties are allowed.

  Watchers

  string

  Emails of operators who can view the task.

  MessagingRecepients

  string

  Emails of operators are receiving messaging receipts.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "TaskId": 0,
    "Number": "string",
    "Title": "string",
    "PreviousTaskStatus": {
      "Id": 0,
      "Title": "string"
    },
    "NewTaskStatus": {
      "Id": 0,
      "Title": "string"
    },
    "ResponsibleOperator": {
      "Id": 0,
      "Email": "string"
    },
    "AssignedOperator": {
      "Id": 0,
      "Email": "string"
    },
    "Watchers": "string",
    "MessagingRecepients": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.maintenance.taskNewInternalComment

  When operator responses with new comment to the maintenance task. Comments are used for communication between team members or store process steps.

  Operation ID{API_ACCESS_KEY}.maintenance.taskNewInternalComment

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Support

  Accepts the following message:

  Maintenance Task New Internal Comment

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  TaskId

  integer

  format: int32

  Ocean unique id of task.

  Number

  string

  Ocean friendly id of task.

  Title

  string

  Title of task.

  PreviousTaskStatus

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of previous task status.

  Title

  string

  Title of task.

  Additional properties are allowed.

  NewTaskStatus

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of new task status.

  Title

  string

  Title of new task status.

  Additional properties are allowed.

  ResponsibleOperator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of responsible operator.

  Email

  string

  Operator email.

  Additional properties are allowed.

  AssignedOperator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of assigned operator.

  Email

  string

  Operator email.

  Additional properties are allowed.

  Watchers

  string

  Emails of operators who can view the task.

  MessagingRecepients

  string

  Emails of operators are receiving messaging receipts.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "TaskId": 0,
    "Number": "string",
    "Title": "string",
    "PreviousTaskStatus": {
      "Id": 0,
      "Title": "string"
    },
    "NewTaskStatus": {
      "Id": 0,
      "Title": "string"
    },
    "ResponsibleOperator": {
      "Id": 0,
      "Email": "string"
    },
    "AssignedOperator": {
      "Id": 0,
      "Email": "string"
    },
    "Watchers": "string",
    "MessagingRecepients": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{chargePointId}.communication.status.changed

  • When heartbeat event is not received in a predefined number of consecutive intervals. Number of consecutive intervals is defined in Settings -> Instance Settings -> Charge Point Communication -> Timings
  • When heartbeat is received after charge point communication was offline.

  Operation ID{API_ACCESS_KEY}.*.*.communication.status.changed

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  chargePointId

  required

  integer

  format: int32

  Charge point ID. Every Charge point has a unique ID.

  • #Online Status

  Accepts the following message:

  Charge Point Communication Status Changed

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  FriendlyName

  string

  Friendly name of the location.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyFullCode

  string

  Friendly code of the charger.

  Additional properties are allowed.

  NoCommunicationStatus

  boolean

  0 - Online, 1 - Offline

  LastCommunicationTime

  string

  format: date-time

  Timestamp when event occurred.

  OfflineFrom

  string

  format: date-time

  OfflineTo

  string

  format: date-time

  TotalIntervalSeconds

  integer

  format: int64

  Current ticket status.

  ServerTimestamp

  string

  format: date-time

  Timestamp when server received the event.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "FriendlyName": "string"
    },
    "ChargePoint": {
      "Id": 0,
      "FriendlyFullCode": "string"
    },
    "NoCommunicationStatus": true,
    "LastCommunicationTime": "2019-08-24T14:15:22Z",
    "OfflineFrom": "2019-08-24T14:15:22Z",
    "OfflineTo": "2019-08-24T14:15:22Z",
    "TotalIntervalSeconds": 0,
    "ServerTimestamp": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.connector.statusChanged

  When connector status changes

  Operation ID{API_ACCESS_KEY}.*.connector.statusChanged

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Online Status

  Accepts the following message:

  Charge Point Connector Status Changed

  • application/json

  Payload

  Expand all

  object

  Timestamp

  string

  format: date-time

  Timestamp when the event occurred.

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  ChargingSession

  Expand all

  object

  Id

  integer

  format: int64

  Unique ID of the charging session

  Additional properties are allowed.

  Evse

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the Evse.

  FriendlyCode

  string

  Friendly code of the EVSE

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  Code

  string

  Friendly code of the connector

  CurrentStatusId

  integer

  format: int16

  0 - unknown/out of communication; 1 - Unavailable; 2 - In fault; 3 - Available; 4 - Reserved; 5 - Occupied; 6 - Finishing; 7 - Out of working time; 8 - Newly inserted, not connected yet; 9 - Preparing; 10 - Suspended EVSE; 11 - Suspended EV

  PreviousStatusId

  integer

  format: int16

  0 - unknown/out of communication; 1 - Unavailable; 2 - In fault; 3 - Available; 4 - Reserved; 5 - Occupied; 6 - Finishing; 7 - Out of working time; 8 - Newly inserted, not connected yet; 9 - Preparing; 10 - Suspended EVSE; 11 - Suspended EV

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  ExternalCode

  string

  External EVSE code. Normally entered into Ocean from ERP system.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Location

  Expand all

  object

  LocationId

  integer

  format: int32

  Unique ID of the charging location.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Timestamp": "2019-08-24T14:15:22Z",
    "InstanceId": 0,
    "UserId": 0,
    "ChargingSession": {
      "Id": 0
    },
    "Evse": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string",
      "Connector": {
        "Id": 0,
        "Code": "string",
        "CurrentStatusId": 0,
        "PreviousStatusId": 0
      },
      "ChargePoint": {
        "Id": 0,
        "ExternalCode": "string",
        "SerialNumber": "string"
      },
      "Location": {
        "LocationId": 0
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.roamingConnectors.statusChanged

  When roaming connector status changes

  Operation ID{API_ACCESS_KEY}.roamingConnectors.statusChanged

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Online Status

  Accepts the following message:

  Roaming Connectors Status Changed

  • application/json

  Payload

  Expand all

  tuple<object, ...optional<any>>

  1 item:

  Expand all

  object

  ConnectorId

  integer

  format: int32

  Unique ID of the connector.

  StatusId

  integer

  format: int16

  0 - unknown/out of communication; 1 - Unavailable; 2 - In fault; 3 - Available; 4 - Reserved; 5 - Occupied; 6 - Finishing; 7 - Out of working time; 8 - Newly inserted, not connected yet; 9 - Preparing; 10 - Suspended EVSE; 11 - Suspended EV

  Timestamp

  string

  format: date-time

  Timestamp when the status change occurred

  Additional properties are allowed.

  Additional items are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  [
    {
      "ConnectorId": 0,
      "StatusId": 0,
      "Timestamp": "2019-08-24T14:15:22Z"
    }
  ]
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{eventTypePriorityId}.{eventSourceId}.system.event

  Informational messages - notifications, warnings, errors

  Operation ID{API_ACCESS_KEY}.*.*.*.system.event

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  eventTypePriorityId

  required

  integer

  format: int32

  Event type priority ID. Every event type priority has a unique ID.

  eventSourceId

  required

  integer

  format: int32

  Event source ID. Every event source has a unique ID.

  • #Online Status

  Accepts the following message:

  Roaming Connectors Status Changed

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  LocationId

  integer

  format: int32

  Unique ID of the charging location.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  FriendlyName

  string

  Friendly name of the location.

  Additional properties are allowed.

  ChargePointId

  integer

  format: int32

  Unique ID of the charger.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  Additional properties are allowed.

  Connector

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the connector.

  FriendlyCode

  string

  Friendly code of the connector.

  Additional properties are allowed.

  EvseId

  integer

  format: int32

  Unique ID of the Evse.

  ConnectorId

  integer

  format: int32

  Unique ID of the connector.

  ChargingSessionId

  integer

  format: int64

  Unique ID of the charging session

  ManipulationOperatorId

  integer

  format: int32

  Ocean unique id of the operator who triggered event.

  Description

  string

  Additional description of the event. It can be empty.

  ServerTimestamp

  string

  format: date-time

  Timestamp when server received the event.

  ChargerTimestamp

  string

  format: date-time

  Timestamp when event was generated on device/charger.

  ChargerSpecific

  Expand all

  object

  VendorErrorCode

  string

  Vendor error code - every vendor has it's own set of error codes.

  EventInfo

  string

  Additional description of event reported. Charger reports this in Info field of status notification.

  Additional properties are allowed.

  Type

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the event type. There is a list of aprox 300 event types in Ocean and new are added constantly.

  Title

  string

  Ocean description of even type.

  Source

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the event source.

  Title

  string

  Ocean description of even source.

  Additional properties are allowed.

  Priority

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the event priority.

  Title

  string

  Ocean description of even source.

  Additional properties are allowed.

  Category

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the event category. Event types are divided into several categories.

  Title

  string

  Ocean description of even category.

  Additional properties are allowed.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "LocationId": 0,
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "FriendlyName": "string"
    },
    "ChargePointId": 0,
    "ChargePoint": {
      "Id": 0,
      "FriendlyCode": "string"
    },
    "Connector": {
      "Id": 0,
      "FriendlyCode": "string"
    },
    "EvseId": 0,
    "ConnectorId": 0,
    "ChargingSessionId": 0,
    "ManipulationOperatorId": 0,
    "Description": "string",
    "ServerTimestamp": "2019-08-24T14:15:22Z",
    "ChargerTimestamp": "2019-08-24T14:15:22Z",
    "ChargerSpecific": {
      "VendorErrorCode": "string",
      "EventInfo": "string"
    },
    "Type": {
      "Id": 0,
      "Title": "string",
      "Source": {
        "Id": 0,
        "Title": "string"
      },
      "Priority": {
        "Id": 0,
        "Title": "string"
      },
      "Category": {
        "Id": 0,
        "Title": "string"
      }
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.security.event

  When system detects security event

  Operation ID{API_ACCESS_KEY}.security.event

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #Online Status

  Accepts the following message:

  Security Event

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  OceanInterfaceId

  integer

  format: int16

  1 - Starfish - Communication with chargers; 2 - Orca Backoffice operators access; 3 - Urchin 3rd party API integration; 4 - Octopus Roaming platforms interfaces; 5 - Dusky front end; 6 - Spinner user payer front end; 7 - Hubject roaming platform.

  EventTypeId

  integer

  format: int32

  389-Too many failed login attempts; 390-API abuse - to many calls - online API; 391-API abuse - to many calls - semionline API; 392-API abuse - to many calls - occasional API; 393-Payment abuse detected - trying to overcome funds preauthorization; 394-XSS injection detected; 395-SQL injection detected; 396-Charger using wrong OCPP Authentication key; 397-API abuse - to many calls - mass API.

  ipAddress

  string

  IP address from where traffic comes.

  Agent

  string

  Agent that triggers this traffic.

  Description

  string

  More detail description of event detected.

  IpAddressBlockTypeId

  integer

  format: int16

  1 - Allow only; 2 - Block.

  IpAddressBlockReasonId

  integer

  format: int16

  1 - Manually; 2 - Automaticaly - suspicius content posted; 3 - Automaticaly - enormus traffic; 4 - Automaticaly - non standard usage patterns.

  Timestamp

  string

  format: date-time

  Timestamp of security event detected

  User

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Additional properties are allowed.

  UserPayer

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the payer who triggered traffic (through fleet app).

  Additional properties are allowed.

  Operator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the operator who triggered traffic (through operator portal or urchin interface).

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "OceanInterfaceId": 0,
    "EventTypeId": 0,
    "ipAddress": "string",
    "Agent": "string",
    "Description": "string",
    "IpAddressBlockTypeId": 0,
    "IpAddressBlockReasonId": 0,
    "Timestamp": "2019-08-24T14:15:22Z",
    "User": {
      "Id": 0
    },
    "UserPayer": {
      "Id": 0
    },
    "Operator": {
      "Id": 0
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.user.account.blocked

  When user is blocked.

  Operation ID{API_ACCESS_KEY}.user.account.blocked

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Account Blocked

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  ExternalCode

  string

  User external code (Example from ERP).

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with user status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 1,
    "UserId": 48710,
    "Email": "john.doe@etrel.si",
    "ExternalCode": "ETR",
    "ExecutedTime": "2023-10-30T07: 53: 03.557Z",
    "ExecutedByOperatorId": 5476
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.user.account.unblocked

  When user is unblocked.

  Operation ID{API_ACCESS_KEY}.user.account.unblocked

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Account Unblocked

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  ExternalCode

  string

  User external code (Example from ERP).

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with user status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 1,
    "UserId": 48710,
    "Email": "john.doe@etrel.si",
    "ExternalCode": "ETR",
    "ExecutedTime": "2023-10-30T07: 53: 03.557Z",
    "ExecutedByOperatorId": 5476
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{userId}.user.account.inserted

  When user is created.

  Operation ID{API_ACCESS_KEY}.*.user.account.inserted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  userId

  required

  integer

  format: int32

  User ID. Every user has a unique ID.

  • #CRM

  Accepts the following message:

  User Account Inserted

  • application/json

  Payload

  Expand all

  object

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  UserPayerId

  integer

  Ocean unique id of user payer.

  Blocked

  boolean

  User account status.

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with user status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserId": 0,
    "Email": "string",
    "UserPayerId": 0,
    "Blocked": true,
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{userId}.user.account.updated

  When user is updated.

  Operation ID{API_ACCESS_KEY}.*.user.account.updated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  userId

  required

  integer

  format: int32

  User ID. Every user has a unique ID.

  • #CRM

  Accepts the following message:

  User Account Updated

  • application/json

  Payload

  Expand all

  object

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  UserPayerId

  integer

  Ocean unique id of user payer.

  Blocked

  boolean

  User account status.

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with user status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserId": 0,
    "Email": "string",
    "UserPayerId": 0,
    "Blocked": true,
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{userId}.user.account.deleted

  When user is updated.

  Operation ID{API_ACCESS_KEY}.*.user.account.deleted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  userId

  required

  integer

  format: int32

  User ID. Every user has a unique ID.

  • #CRM

  Accepts the following message:

  User Account Deleted

  • application/json

  Payload

  Expand all

  object

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  Email

  string

  User’s email.

  UserPayerId

  integer

  Ocean unique id of user payer.

  Blocked

  boolean

  User account status.

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with user status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserId": 0,
    "Email": "string",
    "UserPayerId": 0,
    "Blocked": true,
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.userPayer.account.blocked

  When user payer is blocked.

  Operation ID{API_ACCESS_KEY}.userPayer.account.blocked

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Payer Account Blocked

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer.

  Email

  string

  Payer email.

  ExternalCode

  string

  Payer external code (Example from ERP).

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with payer status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserPayerId": 0,
    "Email": "string",
    "ExternalCode": "string",
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.userPayer.account.unblocked

  When user payer is unblocked.

  Operation ID{API_ACCESS_KEY}.userPayer.account.unblocked

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Payer Account Unblocked

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer.

  Email

  string

  Payer email.

  ExternalCode

  string

  Payer external code (Example from ERP).

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with payer status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserPayerId": 0,
    "Email": "string",
    "ExternalCode": "string",
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.userPayer.account.paymentBlocked

  When user payer payment is blocked.

  Operation ID{API_ACCESS_KEY}.userPayer.account.paymentBlocked

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Payer Account Payment Blocked

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer.

  Email

  string

  Payer email.

  ExternalCode

  string

  Payer external code (Example from ERP).

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with payer status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserPayerId": 0,
    "Email": "string",
    "ExternalCode": "string",
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.userPayer.account.paymentUnblocked

  When user payer payment is unblocked.

  Operation ID{API_ACCESS_KEY}.userPayer.account.paymentUnblocked

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Payer Account Payment Unblocked

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer.

  Email

  string

  Payer email.

  ExternalCode

  string

  Payer external code (Example from ERP).

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with payer status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserPayerId": 0,
    "Email": "string",
    "ExternalCode": "string",
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{userPayerId}.userPayer.account.inserted

  When user payer is created.

  Operation ID{API_ACCESS_KEY}.*.userPayer.account.inserted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  userPayerId

  required

  integer

  format: int32

  User payer ID. Every payer has a unique ID.

  • #CRM

  Accepts the following message:

  User Payer Account Inserted

  • application/json

  Payload

  Expand all

  object

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer who is the owner of the payment card.

  Email

  string

  Payer's email.

  Blocked

  boolean

  Payer account status.

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with payer status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserPayerId": 0,
    "Email": "string",
    "Blocked": true,
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{userPayerId}.userPayer.account.updated

  When user payer is updated.

  Operation ID{API_ACCESS_KEY}.*.userPayer.account.updated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  userPayerId

  required

  integer

  format: int32

  User payer ID. Every payer has a unique ID.

  • #CRM

  Accepts the following message:

  User Payer Account Updated

  • application/json

  Payload

  Expand all

  object

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer who is the owner of the payment card.

  Email

  string

  Payer's email.

  Blocked

  boolean

  Payer account status.

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with payer status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserPayerId": 0,
    "Email": "string",
    "Blocked": true,
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{userPayerId}.userPayer.account.deleted

  When user payer is updated.

  Operation ID{API_ACCESS_KEY}.*.userPayer.account.deleted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  userPayerId

  required

  integer

  format: int32

  User payer ID. Every payer has a unique ID.

  • #CRM

  Accepts the following message:

  User Payer Account Deleted

  • application/json

  Payload

  Expand all

  object

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer who is the owner of the payment card.

  Email

  string

  Payer's email.

  Blocked

  boolean

  Payer account status.

  ExecutedTime

  string

  format: date-time

  Manipulation timestamp.

  ExecutedByOperatorId

  integer

  format: int32

  Ocean unique id of the operator who manipulated with payer status.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserPayerId": 0,
    "Email": "string",
    "Blocked": true,
    "ExecutedTime": "2019-08-24T14:15:22Z",
    "ExecutedByOperatorId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.userRegistration.pending

  Once customer triggered registration which requres further confirmation by operator. This will be send only in the case of subscribers.

  Operation ID{API_ACCESS_KEY}.userRegistration.pending

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Registration Pending

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserRegistrationTypeId

  integer

  format: int32

  Ocean unique id of the registration type. In this case you will always get 2 - which is subscriber registration, which requires some special checking.

  UserFirstName

  string

  First name of the user who will use new account.

  UserLastName

  string

  Last name of the user who will use new account.

  UserEmail

  string

  Email of the user who will use new account.

  UserPayerCompanyName

  string

  Company name of the payer (customer). This could also be empty if payer is a physical person.

  UserPayerFirstName

  string

  First name of the payer (customer) who will be paying for services. In the case of the company, contact person can be here.

  UserPayerLastName

  string

  Last name of the payer (customer) who will be paying for services. In the case of the company, contact person can be here..

  ContractTypeId

  integer

  format: int32

  Ocean unique id of the user contract type.

  RegistrationTime

  string

  format: date-time

  Timestamp when registration was summitted.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserRegistrationTypeId": 0,
    "UserFirstName": "string",
    "UserLastName": "string",
    "UserEmail": "string",
    "UserPayerCompanyName": "string",
    "UserPayerFirstName": "string",
    "UserPayerLastName": "string",
    "ContractTypeId": 0,
    "RegistrationTime": "2019-08-24T14:15:22Z"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.user.firstlogin

  When user logins into the system for the first time.

  Operation ID{API_ACCESS_KEY}.user.firstlogin

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User First Login

  • application/json

  Payload

  Expand all

  object

  UserId

  integer

  format: int32

  User ID. Every user has unique ID.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "UserId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.user.account.fundstopup

  When customer from Driver app or API executes on user or payer prepayment account.

  Operation ID{API_ACCESS_KEY}.user.account.fundstopup

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Account Funds Topup

  • application/json

  Payload

  Expand all

  object

  TransactionId

  integer

  format: int64

  Payment transaction unique id.

  TransactionNumber

  string

  Ocean friendly code of transaction. Number starts from 1 every year.

  ExternalMoneyUploadCode

  string

  External code of transaction. This is normally used when topup is executed through API, which is normally followed by bank transaction.

  ExternalMoneyUploadDescription

  string

  Details of topup, where operator can add more information about bank transaction, etc.

  User

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  FirstName

  string

  User first name.

  LastName

  string

  User last name.

  IsCompany

  integer

  format: int16

  0-person; 1-company.

  CompanyName

  string

  User company name if user is company.

  Email

  string

  User email.

  GSMNumber

  string

  User mobile number.

  ExternalCode

  string

  External id of the user (normally ERP id).

  TaxNumber

  string

  User tax number.

  UICulture

  string

  User UI culture based on ISO.

  Additional properties are allowed.

  UserPayer

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the payer.

  FirstName

  string

  Payer first name.

  LastName

  string

  Payer last name.

  IsCompany

  integer

  format: int16

  0-person; 1-company.

  CompanyName

  string

  Payer company name if user is company.

  Email

  string

  Payer email.

  ExternalCode

  string

  External id of the payer (normally ERP id).

  TaxNumber

  string

  Payer tax number.

  UICulture

  string

  Payer UI culture based on ISO.

  Additional properties are allowed.

  Purchase

  Expand all

  object

  PaymentProviderReference

  string

  In the case that purchase has been processed through payment provider, we get a reference to payment provider purchase id here.

  Additional properties are allowed.

  PaymentTypeId

  integer

  format: int16

  1 - PERUSAGE; 2 - PERSESSIONQUANTATIES; 3 - SUBSCRIPTION; 4 - PERUSAGE; 5 - PAYASYOUGO.

  Timestamp

  string

  format: date-time

  Timestamp of money transaction.

  Direction

  string

  UP - Money refunded or topped up on account; DOWN - money decreased from account.

  TransactionType

  Expand all

  object

  Id

  integer

  format: int16

  1 - Reservation fee; 2 - Access fee; 3 - Parking time fee [hour]; 4 - Max charging power fee; 5 - Consumed energy fee; 6 - Charging time fee [hour]; 7 - Parking time fee [min]; 8 - Charging time fee [min]; 9 - Unexecuted reservation fee; 10 - Monthly subscription; 11 - RFID card cost; 12 - Upload funds on user account.

  Title

  string

  Transaction type title.

  Unit

  string

  Transaction unit.

  Additional properties are allowed.

  Quantity

  number

  format: float

  Transaction quantity, unit is defined in object TariffTransactionTypePrice.PricePerUnit.

  Amount

  number

  format: float

  Transaction amount with tax.

  AmountWithoutTax

  number

  format: float

  Transaction amount without tax.

  CurrencyCode

  string

  Instance currency.

  BalanceMoneyBeforeTransaction

  number

  format: float

  Prepayment account status (funds on account) with tax before topup transaction.

  BalanceMoneyWithoutTaxBeforeTransaction

  number

  format: float

  Prepayment account status (funds on account) without tax before topup transaction.

  BalanceMoneyAfterTransaction

  number

  format: float

  Prepayment account status (funds on account) with tax after topup transaction

  BalanceMoneyWithoutTaxAfterTransaction

  number

  format: float

  Prepayment account status (funds on account) without tax after topup transaction.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "TransactionId": 0,
    "TransactionNumber": "string",
    "ExternalMoneyUploadCode": "string",
    "ExternalMoneyUploadDescription": "string",
    "User": {
      "Id": 0,
      "FirstName": "string",
      "LastName": "string",
      "IsCompany": 0,
      "CompanyName": "string",
      "Email": "string",
      "GSMNumber": "string",
      "ExternalCode": "string",
      "TaxNumber": "string",
      "UICulture": "string"
    },
    "UserPayer": {
      "Id": 0,
      "FirstName": "string",
      "LastName": "string",
      "IsCompany": 0,
      "CompanyName": "string",
      "Email": "string",
      "ExternalCode": "string",
      "TaxNumber": "string",
      "UICulture": "string"
    },
    "Purchase": {
      "PaymentProviderReference": "string"
    },
    "PaymentTypeId": 0,
    "Timestamp": "2019-08-24T14:15:22Z",
    "Direction": "string",
    "TransactionType": {
      "Id": 0,
      "Title": "string",
      "Unit": "string"
    },
    "Quantity": 0.1,
    "Amount": 0.1,
    "AmountWithoutTax": 0.1,
    "CurrencyCode": "string",
    "BalanceMoneyBeforeTransaction": 0.1,
    "BalanceMoneyWithoutTaxBeforeTransaction": 0.1,
    "BalanceMoneyAfterTransaction": 0.1,
    "BalanceMoneyWithoutTaxAfterTransaction": 0.1
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.user.account.manualbalance

  When operator executes manual balance on user account. Normally executed as a part of dispute process for postpayers or prepayers.

  Operation ID{API_ACCESS_KEY}.user.account.manualbalance

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Account Manual Balance

  • application/json

  Payload

  Expand all

  object

  TransactionId

  integer

  format: int64

  Payment transaction unique id.

  TransactionNumber

  string

  Ocean friendly code of transaction. Number starts from 1 every year.

  ExternalMoneyUploadCode

  string

  External code of transaction. This is normally used when topup is executed through API, which is normally followed by bank transaction.

  ExternalMoneyUploadDescription

  string

  Details of topup, where operator can add more information about bank transaction, etc.

  OperatorDescription

  string

  Operator description why this manual balance has been executed.

  ManuallyInsertedByOperator

  string

  Email (unique identifier) of operator who has executed this manual balance action

  User

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  FirstName

  string

  User first name.

  LastName

  string

  User last name.

  IsCompany

  integer

  format: int16

  0-person; 1-company.

  CompanyName

  string

  User company name if user is company.

  Email

  string

  User email.

  GSMNumber

  string

  User mobile number.

  ExternalCode

  string

  External id of the user (normally ERP id).

  TaxNumber

  string

  User tax number.

  UICulture

  string

  User UI culture based on ISO.

  Additional properties are allowed.

  UserPayer

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the payer.

  FirstName

  string

  Payer first name.

  LastName

  string

  Payer last name.

  IsCompany

  integer

  format: int16

  0-person; 1-company.

  CompanyName

  string

  Payer company name if user is company.

  Email

  string

  Payer email.

  ExternalCode

  string

  External id of the payer (normally ERP id).

  TaxNumber

  string

  Payer tax number.

  UICulture

  string

  Payer UI culture based on ISO.

  Additional properties are allowed.

  PaymentTypeId

  integer

  format: int16

  1 - PERUSAGE; 2 - PERSESSIONQUANTATIES; 3 - SUBSCRIPTION; 4 - PERUSAGE; 5 - PAYASYOUGO.

  Timestamp

  string

  format: date-time

  Timestamp of money transaction.

  Direction

  string

  UP- Money refunded or topped up on account; DOWN - money decreased from account.

  TransactionType

  Expand all

  object

  Id

  integer

  format: int16

  1 - Reservation fee; 2 - Access fee; 3 - Parking time fee [hour]; 4 - Max charging power fee; 5 - Consumed energy fee; 6 - Charging time fee [hour]; 7 - Parking time fee [min]; 8 - Charging time fee [min]; 9 - Unexecuted reservation fee; 10 - Monthly subscription; 11 - RFID card cost; 12 - Upload funds on user account.

  Title

  string

  Transaction type title.

  Unit

  string

  Transaction unit.

  Additional properties are allowed.

  Quantity

  number

  format: float

  Transaction quantity, unit is defined in object TariffTransactionTypePrice.PricePerUnit.

  Amount

  number

  format: float

  Transaction amount with tax.

  AmountWithoutTax

  number

  format: float

  Transaction amount without tax.

  CurrencyCode

  string

  Instance currency.

  BalanceMoneyBeforeTransaction

  number

  format: float

  Prepayment account status (funds on account) with tax before topup transaction.

  BalanceMoneyWithoutTaxBeforeTransaction

  number

  format: float

  Prepayment account status (funds on account) without tax before topup transaction.

  BalanceMoneyAfterTransaction

  number

  format: float

  Prepayment account status (funds on account) with tax after topup transaction

  BalanceMoneyWithoutTaxAfterTransaction

  number

  format: float

  Prepayment account status (funds on account) without tax after topup transaction.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "TransactionId": 0,
    "TransactionNumber": "string",
    "ExternalMoneyUploadCode": "string",
    "ExternalMoneyUploadDescription": "string",
    "OperatorDescription": "string",
    "ManuallyInsertedByOperator": "string",
    "User": {
      "Id": 0,
      "FirstName": "string",
      "LastName": "string",
      "IsCompany": 0,
      "CompanyName": "string",
      "Email": "string",
      "GSMNumber": "string",
      "ExternalCode": "string",
      "TaxNumber": "string",
      "UICulture": "string"
    },
    "UserPayer": {
      "Id": 0,
      "FirstName": "string",
      "LastName": "string",
      "IsCompany": 0,
      "CompanyName": "string",
      "Email": "string",
      "ExternalCode": "string",
      "TaxNumber": "string",
      "UICulture": "string"
    },
    "PaymentTypeId": 0,
    "Timestamp": "2019-08-24T14:15:22Z",
    "Direction": "string",
    "TransactionType": {
      "Id": 0,
      "Title": "string",
      "Unit": "string"
    },
    "Quantity": 0.1,
    "Amount": 0.1,
    "AmountWithoutTax": 0.1,
    "CurrencyCode": "string",
    "BalanceMoneyBeforeTransaction": 0.1,
    "BalanceMoneyWithoutTaxBeforeTransaction": 0.1,
    "BalanceMoneyAfterTransaction": 0.1,
    "BalanceMoneyWithoutTaxAfterTransaction": 0.1
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.user.account.empty

  After session user billing is successfully executed and system detects that user's account is almost empty.

  Operation ID{API_ACCESS_KEY}.*.user.account.empty

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #CRM

  Accepts the following message:

  User Prepayment Account Empty

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  CurrentAccountStatus

  number

  format: float

  User current account status(funds on account), unit instance currency.

  MinAccountAmountToStartCharging

  number

  format: float

  System settings - minimum amount to start charging, unit instance currency.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "CurrentAccountStatus": 0.1,
    "MinAccountAmountToStartCharging": 0.1
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.user.paymentCard.revalidationRequired

  When Ocean payment system discovers that payment card which is used in MIT (merchant initiated payment) needs revalidation. Customer gets notified about it.

  Operation ID{API_ACCESS_KEY}.user.paymentCard.revalidationRequired

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Payment Card Requires Revalidation

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserId

  integer

  format: int32

  Ocean unique id of the user who is the owner of the payment card.

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer.

  Issuer

  string

  Card processor who issued the payment card.

  CardNumber

  string

  Customer masked card number that was blocked.

  ExpirationDate

  string

  format: DateTime

  Timestamp when it has been discovered that payment card needs revalidation.

  PayInMethodId

  integer

  format: int32

  Ocean unique id payment card (PayInMethod).

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserId": 0,
    "UserPayerId": 0,
    "Issuer": "string",
    "CardNumber": "string",
    "ExpirationDate": "string",
    "PayInMethodId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.user.paymentCard.validated

  When payment card is validated.

  Operation ID{API_ACCESS_KEY}.user.paymentCard.validated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  • #CRM

  Accepts the following message:

  User Payment Card Validated

  • application/json

  Payload

  Expand all

  object

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  UserPayerId

  integer

  format: int32

  Ocean unique id of the payer who is paying for the user services.

  PayInMethodId

  integer

  format: int32

  Ocean unique id payment card (PayInMethod).

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "InstanceId": 0,
    "UserPayerId": 0,
    "PayInMethodId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{chargePointId}.chargepoint.inserted

  When operator or API inserts new charger.

  Operation ID{API_ACCESS_KEY}.*.*.chargepoint.inserted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  chargePointId

  required

  integer

  format: int32

  Charge point ID. Every Charge point has a unique ID.

  • #Asset management

  Accepts the following message:

  Charge Point Inserted

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  ExternalCode

  string

  External code of location asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  LocationCluster

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charging location cluster.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  ExternalCode

  string

  External charger code. Normally entered into Ocean from ERP system.

  IsSimulator

  integer

  format: int16

  1 - if charger has been added as simulator; 0 - if charger hasn't been added as simulator.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  Model

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charger model.

  Additional properties are allowed.

  Additional properties are allowed.

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string"
    },
    "LocationCluster": {
      "Id": 0
    },
    "ChargePoint": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string",
      "IsSimulator": 0,
      "SerialNumber": "string",
      "Model": {
        "Id": 0
      }
    },
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{chargePointId}.chargepoint.updated

  When operator or API inserts new charger.

  Operation ID{API_ACCESS_KEY}.*.*.chargepoint.updated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  chargePointId

  required

  integer

  format: int32

  Charge point ID. Every Charge point has a unique ID.

  • #Asset management

  Accepts the following message:

  Charge Point Updated

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  ExternalCode

  string

  External code of location asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  LocationCluster

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charging location cluster.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  ExternalCode

  string

  External charger code. Normally entered into Ocean from ERP system.

  IsSimulator

  integer

  format: int16

  1 - if charger has been added as simulator; 0 - if charger hasn't been added as simulator.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  Model

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charger model.

  Additional properties are allowed.

  Additional properties are allowed.

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string"
    },
    "LocationCluster": {
      "Id": 0
    },
    "ChargePoint": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string",
      "IsSimulator": 0,
      "SerialNumber": "string",
      "Model": {
        "Id": 0
      }
    },
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{chargePointId}.chargepoint.deleted

  When operator or API inserts new charger.

  Operation ID{API_ACCESS_KEY}.*.*.chargepoint.deleted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  chargePointId

  required

  integer

  format: int32

  Charge point ID. Every Charge point has a unique ID.

  • #Asset management

  Accepts the following message:

  Charge Point Deleted

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  ExternalCode

  string

  External code of location asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  LocationCluster

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charging location cluster.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  ExternalCode

  string

  External charger code. Normally entered into Ocean from ERP system.

  IsSimulator

  integer

  format: int16

  1 - if charger has been added as simulator; 0 - if charger hasn't been added as simulator.

  SerialNumber

  string

  Charger serial number. Normally written on charger faceplate.

  Model

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charger model.

  Additional properties are allowed.

  Additional properties are allowed.

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string"
    },
    "LocationCluster": {
      "Id": 0
    },
    "ChargePoint": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string",
      "IsSimulator": 0,
      "SerialNumber": "string",
      "Model": {
        "Id": 0
      }
    },
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.location.inserted

  When operator or API inserts new location.

  Operation ID{API_ACCESS_KEY}.*.location.inserted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Asset management

  Accepts the following message:

  Location Inserted

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  Address

  string

  Location full address (street, house number, postal code, city).

  Additional properties are allowed.

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "Address": "string"
    },
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.location.updated

  When operator or API updates data of the existing location.

  Operation ID{API_ACCESS_KEY}.*.location.updated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Asset management

  Accepts the following message:

  Location Updated

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  Address

  string

  Location full address (street, house number, postal code, city).

  Additional properties are allowed.

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "Address": "string"
    },
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.location.deleted

  When operator or API deletes existing location.

  Operation ID{API_ACCESS_KEY}.*.location.deleted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Asset management

  Accepts the following message:

  Location Deleted

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  Address

  string

  Location full address (street, house number, postal code, city).

  Additional properties are allowed.

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "Address": "string"
    },
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{locationClusterId}.locationCluster.inserted

  When operator or API inserts new location cluster.

  Operation ID{API_ACCESS_KEY}.*.*.locationCluster.inserted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  locationClusterId

  required

  integer

  format: int32

  Location cluster ID. Every location cluster has a unique ID.

  • #Asset management

  Accepts the following message:

  Location Cluster Inserted

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  ExternalCode

  string

  External code of location asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  LocationCluster

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charging location cluster.

  ExternalCode

  string

  External code of location cluster asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string"
    },
    "LocationCluster": {
      "Id": 0,
      "ExternalCode": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{locationClusterId}.locationCluster.updated

  When operator or API updates data of the existing location cluster.

  Operation ID{API_ACCESS_KEY}.*.*.locationCluster.updated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  locationClusterId

  required

  integer

  format: int32

  Location cluster ID. Every location cluster has a unique ID.

  • #Asset management

  Accepts the following message:

  Location Cluster Updated

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  ExternalCode

  string

  External code of location asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  LocationCluster

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charging location cluster.

  ExternalCode

  string

  External code of location cluster asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string"
    },
    "LocationCluster": {
      "Id": 0,
      "ExternalCode": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.{locationClusterId}.locationCluster.deleted

  When operator or API deletes existing location cluster.

  Operation ID{API_ACCESS_KEY}.*.*.locationCluster.deleted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  locationClusterId

  required

  integer

  format: int32

  Location cluster ID. Every location cluster has a unique ID.

  • #Asset management

  Accepts the following message:

  Location Cluster Deleted

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  ExternalCode

  string

  External code of location asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  LocationCluster

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charging location cluster.

  ExternalCode

  string

  External code of location cluster asset (to connect asset with external system like ERP).

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "ExternalCode": "string"
    },
    "LocationCluster": {
      "Id": 0,
      "ExternalCode": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{loadAreaId}.loadArea.inserted

  When operator or API inserts new load area.

  Operation ID{API_ACCESS_KEY}.*.loadArea.inserted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  loadAreaId

  required

  integer

  format: int32

  Load area ID. Every load area has a unique ID.

  • #Asset management

  Accepts the following message:

  Load Area Inserted

  • application/json

  Payload

  Expand all

  object

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{loadAreaId}.loadArea.updated

  When operator or API updates data of the existing load area.

  Operation ID{API_ACCESS_KEY}.*.loadArea.updated

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  loadAreaId

  required

  integer

  format: int32

  Load area ID. Every load area has a unique ID.

  • #Asset management

  Accepts the following message:

  Load Area Updated

  • application/json

  Payload

  Expand all

  object

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{loadAreaId}.loadArea.deleted

  When operator or API deletes data of the existing load area.

  Operation ID{API_ACCESS_KEY}.*.loadArea.deleted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  loadAreaId

  required

  integer

  format: int32

  Load area ID. Every load area has a unique ID.

  • #Asset management

  Accepts the following message:

  Load Area Deleted

  • application/json

  Payload

  Expand all

  object

  LoadArea

  Expand all

  restricted any

  Id

  integer

  format: int32

  Ocean unique id of the load area.

  Code

  string

  Charger serial number. Normally written on charger faceplate.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "LoadArea": {
      "Id": 0,
      "Code": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.chargepoint.subcpo.newrequest

  When Sub CPO operator requests anew charge point.

  Operation ID{API_ACCESS_KEY}.*.chargepoint.subcpo.newrequest

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Asset management

  Accepts the following message:

  New Charge Point Request By Sub CPO

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  FriendlyName

  string

  Ocean friendly name of the location.

  Address

  string

  Location full address (street, house number, postal code, city).

  Additional properties are allowed.

  LocationCluster

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the charging location cluster.

  Additional properties are allowed.

  ChargePoint

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charger.

  FriendlyCode

  string

  Friendly code of the charger.

  ModelName

  string

  Name of the selected charger model.

  Additional properties are allowed.

  SubCPO

  Expand all

  object

  Name

  string

  Name (company name) of the partner requesting new charger.

  OperatorEmail

  string

  Email of Sub CPO operator posting new charger request.

  Additional properties are allowed.

  InstanceId

  integer

  format: int32

  Instance ID. Every tenant has unique ID.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "FriendlyName": "string",
      "Address": "string"
    },
    "LocationCluster": {
      "Id": 0
    },
    "ChargePoint": {
      "Id": 0,
      "FriendlyCode": "string",
      "ModelName": "string"
    },
    "SubCPO": {
      "Name": "string",
      "OperatorEmail": "string"
    },
    "InstanceId": 0
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.location.subcpo.inserted

  When Sub CPO operator inserts a new location.

  Operation ID{API_ACCESS_KEY}.*.location.subcpo.inserted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Asset management

  Accepts the following message:

  New Location Sub CPO Inserted

  • application/json

  Payload

  Expand all

  object

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyCode

  string

  Friendly code of the location.

  Address

  string

  Location full address (street, house number, postal code, city).

  Additional properties are allowed.

  SubCPO

  Expand all

  object

  Name

  string

  Name (company name) of the partner requesting new charger.

  OperatorEmail

  string

  Email of Sub CPO operator posting new charger request.

  Additional properties are allowed.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Location": {
      "Id": 0,
      "FriendlyCode": "string",
      "Address": "string"
    },
    "SubCPO": {
      "Name": "string",
      "OperatorEmail": "string"
    }
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.tariff.subcpo.accepted

  When operator checks/edit and accepts proposed tariff from Sub CPO.

  Operation ID{API_ACCESS_KEY}.*.tariff.subcpo.accepted

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Tariff

  Accepts the following message:

  Tariff Sub CPO Accepted

  • application/json

  Payload

  Expand all

  object

  MessagingRecepients

  string

  Email of Sub CPO operator who has inserted tariff proposal - used for messaging purposes- let him know about approval result.

  Tariff

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the tariff. Check tariffs under Billing and payment, where you can also find tariff id.

  Title

  string

  Tariff title.

  Additional properties are allowed.

  SubCPO

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the business partner (Sub CPO) who has posted the tariff proposal. Please check business partners under Assets->Charge point owners, to get business partner id.

  Title

  string

  Ocean business partner name (Sub CPO) who has posted the tariff proposal.

  Operator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of operator who has proposed tariff.

  FirstName

  string

  Operator first name of operator who has proposed tariff.

  LastName

  string

  Operator last name of operator who has proposed tariff.

  Email

  string

  Email of Sub CPO operator posting new charger request.

  Additional properties are allowed.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyName

  string

  Ocean friendly name of the location.

  FriendlyCode

  string

  Friendly code of the location.

  Additional properties are allowed.

  Description

  string

  Operator description why tariff has been accepted or denied.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "MessagingRecepients": "string",
    "Tariff": {
      "Id": 0,
      "Title": "string"
    },
    "SubCPO": {
      "Id": 0,
      "Title": "string",
      "Operator": {
        "Id": 0,
        "FirstName": "string",
        "LastName": "string",
        "Email": "string"
      }
    },
    "Location": {
      "Id": 0,
      "FriendlyName": "string",
      "FriendlyCode": "string"
    },
    "Description": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.tariff.subcpo.denied

  When operator checks/edit and denies proposed tariff from Sub CPO.

  Operation ID{API_ACCESS_KEY}.*.tariff.subcpo.denied

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Tariff

  Accepts the following message:

  Tariff Sub CPO Denied

  • application/json

  Payload

  Expand all

  object

  MessagingRecepients

  string

  Email of Sub CPO operator who has inserted tariff proposal - used for messaging purposes- let him know about approval result.

  Tariff

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the tariff. Check tariffs under Billing and payment, where you can also find tariff id.

  Title

  string

  Tariff title.

  Additional properties are allowed.

  SubCPO

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the business partner (Sub CPO) who has posted the tariff proposal. Please check business partners under Assets->Charge point owners, to get business partner id.

  Title

  string

  Ocean business partner name (Sub CPO) who has posted the tariff proposal.

  Operator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of operator who has proposed tariff.

  FirstName

  string

  Operator first name of operator who has proposed tariff.

  LastName

  string

  Operator last name of operator who has proposed tariff.

  Email

  string

  Email of Sub CPO operator posting new charger request.

  Additional properties are allowed.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyName

  string

  Ocean friendly name of the location.

  FriendlyCode

  string

  Friendly code of the location.

  Additional properties are allowed.

  Description

  string

  Operator description why tariff has been accepted or denied.

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "MessagingRecepients": "string",
    "Tariff": {
      "Id": 0,
      "Title": "string"
    },
    "SubCPO": {
      "Id": 0,
      "Title": "string",
      "Operator": {
        "Id": 0,
        "FirstName": "string",
        "LastName": "string",
        "Email": "string"
      }
    },
    "Location": {
      "Id": 0,
      "FriendlyName": "string",
      "FriendlyCode": "string"
    },
    "Description": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.

• SUB {API_ACCESS_KEY}.{locationId}.tariff.subcpo.pending

  When Sub CPO operator posts new tariff that needs to be reviewed by CPO price administrator.

  Operation ID{API_ACCESS_KEY}.*.tariff.subcpo.pending

  Parameters

  Expand all

  object

  API_ACCESS_KEY

  required

  string

  API Access key. This can be configured in the Ocean's operator portal.

  locationId

  required

  integer

  format: int32

  Location ID. Every location has a unique ID.

  • #Tariff

  Accepts the following message:

  Tariff Sub CPO Pending

  • application/json

  Payload

  Expand all

  object

  Tariff

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the tariff. Check tariffs under Billing and payment, where you can also find tariff id.

  Title

  string

  Tariff title.

  Additional properties are allowed.

  SubCPO

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of the business partner (Sub CPO) who has posted the tariff proposal. Please check business partners under Assets->Charge point owners, to get business partner id.

  Title

  string

  Ocean business partner name (Sub CPO) who has posted the tariff proposal.

  Operator

  Expand all

  object

  Id

  integer

  format: int32

  Ocean unique id of operator who has proposed tariff.

  FirstName

  string

  Operator first name of operator who has proposed tariff.

  LastName

  string

  Operator last name of operator who has proposed tariff.

  Email

  string

  Email of Sub CPO operator posting new charger request.

  Additional properties are allowed.

  Additional properties are allowed.

  Location

  Expand all

  object

  Id

  integer

  format: int32

  Unique ID of the charging location.

  FriendlyName

  string

  Ocean friendly name of the location.

  FriendlyCode

  string

  Friendly code of the location.

  Additional properties are allowed.

  Description

  string

  Operator description why tariff has been accepted or denied.

  PriceType

  string

  This are the basic price types that are proposed to Sub CPO operator Enumeration/descriptions - 1. “Simple AC local/host users”; 2. “Simple DC local/host users”; 3. “Simple AC invited users”; 4. “Simple DC invited users”; 5. “Simple AC public users”; 6. “Simple DC public users”; 7. “Custom complex pricing”

  Additional properties are allowed.

  Headers

  Expand all

  object

  Type

  string

  VersionMajor

  integer

  VersionMinor

  integer

  Route

  string

  Sent (UTC)

  string

  format: date-time

  Sent AMQP 1.0 (UTC)

  string

  format: date-time

  Additional properties are allowed.

  Examples

  Payload

  {
    "Tariff": {
      "Id": 0,
      "Title": "string"
    },
    "SubCPO": {
      "Id": 0,
      "Title": "string",
      "Operator": {
        "Id": 0,
        "FirstName": "string",
        "LastName": "string",
        "Email": "string"
      }
    },
    "Location": {
      "Id": 0,
      "FriendlyName": "string",
      "FriendlyCode": "string"
    },
    "Description": "string",
    "PriceType": "string"
  }
  

  This example has been generated automatically.

  Headers

  {
    "Type": "operationId",
    "VersionMajor": 1,
    "VersionMinor": 0,
    "Route": "route.key",
    "Sent (UTC)": "12.09.2023 08:36:06.45800",
    "Sent AMQP 1.0 (UTC)": "12.09.2023 08:36:06.45800"
  }
  

  This example has been generated automatically.