Usage place

This guide explains the functionality and messages used to update energy usage place information in the Ropo One system, such as updating whether a usage place is disconnected or reconnected. It outlines the Ropo One interface (REST API) and message format (JSON). If these capabilities do not align with the client’s system, alternative interfaces (e.g., SFTP) and message formats can be agreed upon, provided they meet Ropo One’s requirements. Such alternatives must be discussed and agreed upon separately during the implementation project.

Services

Disconnected

When a usage place is disconnected on the client side after a disconnection request from Ropo One, the action must be reported to Ropo One.

Example Message:

{
    "contract_no": "555555b",
    "customernumber": "A123456",
    "description": "Usage place disconnected",
    "id": "1a2b3c4d5",
    "invoices": [
        {
            "invoicenumber": "594294",
            "jobid": "1234"
        }
    ],
    "status": "disconnected",
    "time": "2024-01-04 10:41:40",
    "usageplacecode": "643007572062443672"
}

Connected

When a usage place is connected on the client side after a connection request from Ropo One, the action must be reported to Ropo One.

Example Message:

{
    "contract_no": "555555b",
    "customernumber": "A123456",
    "description": "Usage place connected",
    "id": "1a2b3c4d5",
    "invoices": [
        {
            "invoicenumber": "594294",
            "jobid": "1234"
        }
    ],
    "status": "connected",
    "time": "2024-01-04 10:41:40",
    "usageplacecode": "643007572062443672"
}

Not Disconnected

When a usage place is not disconnected on the client side after a disconnection request from Ropo One, the action must be reported to Ropo One. The message must include a description explaining why the disconnection could not be completed.

Example Message:

{
    "contract_no": "555555b",
    "customernumber": "A123456",
    "description": "Usage place not disconnected",
    "id": "1a2b3c4d5",
    "invoices": [
        {
            "invoicenumber": "594294",
            "jobid": "1234"
        }
    ],
    "status": "notdisconnected",
    "time": "2024-01-04 10:41:40",
    "usageplacecode": "643007572062443672"
}

API interface for delivering disconnection / reconnection events

post

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

UsageplaceEvent

idstringOptional

Unique id for the event

Example: 1a2b3c4d5

usageplacecodestringOptional

Usageplacecode

Example: RE12345

customernumberstringOptional

Customernumer

Example: A123456

contract_nostringOptional

Contractnumber

Example: 555555b

timestringOptional

Time of event

Example: 2024-01-04 10:41:40

statusstringOptional

Type of event

Example: connected

descriptionstringOptional

Further description of the event

Example: Usageplace connected

Responses

200

Successful operation

No content

400

Bad request

application/json

401

Unauthorized

post

/usageplace/event

HTTPcURLJavaScriptPython

POST /rest/usageplace/event HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 238

{
  "id": "1a2b3c4d5",
  "usageplacecode": "RE12345",
  "customernumber": "A123456",
  "contract_no": "555555b",
  "invoices": [
    {
      "jobid": "1234",
      "invoicenumber": "594294"
    }
  ],
  "time": "2024-01-04 10:41:40",
  "status": "connected",
  "description": "Usageplace connected"
}

No content