GET /integration/assets/r1/accounts

BPMN Diagram

Business Logic

This Integration API gets an Account with its Address.

One of code or externalCode must be present. If code is provided it has the precedence among the other fields. If externalCode is provided then externalSystemCode becomes mandatory.

System verifies Permission Required and starts the elaboration that is organized in steps.

STEP 1 - External System Validation

System takes Input fields and checks their existence in internal configuration.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 2 - Account Retrieve

System takes Input fields and checks their existence.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 3 - Operation Center Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 4 - Account Type Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 5 - Address Retrieve

System takes Input fields and retrieve the address of the asset.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 6 - Country Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 7 - District Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 8 - Contacts Retrieve

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 9 - Contact Information Transcode

The following steps are executed for each Contact retrieved.

STEP 9a - Contact Type Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 10 - Meters Retrieve

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 11 - Meter Information Transcode

The following steps are executed for each Meter retrieved.

STEP 11a - Meter Brand Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 11b - Meter Location Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 11c - Meter Type Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → continue to next step.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

STEP 11d - Meter Class Transcode

System takes Input fields and gets the resource.

If System can obtain the Output fields → elaboration is stopped. See Response payload fields.

If System can’t obtain the Output fields → responds with error. Elaboration is stopped.

Path Parameters

As their name suggests, they are included in the URL path of the endpoint.

Not applicable.

Query String Parameters

Start with a ? and includes parameters listed one after the another separated by &.

Filter

Fields

The parameter _fields allows to choose output fields. More info here How to use APIs: Output fields selection.

Header Parameters

Parameters included in the request headers. Generally, request headers are used to keep authorization parameters.

Default.

Request Body Parameters

Request body parameters are used when clients send data to the API. They are shipped in a JSON Object only in POST, PUT, or PATCH requests.

Not applicable.

Request example

{baseUrl}/integration/assets/r1/accounts?externalSystemCode=SAP&externalCode=ACC_001

Response documentation

Response payload fields

operationCenterObject

externalSystemObject

addressObject

typeObject

contactTypeObject

brandObject

locationObject

meterTypeObject

classObject

Compliant with RFC Standard https://www.rfc-editor.org/rfc/rfc9457.html

Extension fields:

Response example

{
  "extension": {
    "myFieldName": "myValue"
  },
  "id": 123456,
  "code": "string",
  "description": "string",
  "fiscalCode": "string",
  "note": "string",
  "birthDate": "2024-02-12T14:39:34.843Z",
  "externalCode": "string",
  "operationCenter": {
    "extension": {},
    "code": "OCGAS",
    "description": [
      {
        "lang": "en",
        "value": "Center Gass OC"
      }
    ]
  },
  "type": {
  "extension": {},
  "code": "PW",
    "description": [
      {
        "lang": "en",
        "value": "Power Transformer"
      }
    ]
  },
  "externalSystem": {
    "extension": {},
    "code": "SAP",
    "description": "SAP"
  },
  "address": {
      "extension": {},
      "description": "INITIAL ADDRESS",
      "countryIsoAlphaCode": "IT",
      "districtAcronym": "MI",
      "municipality": "MILANO",
      "municipalityCode": "015146",
      "locality": "MILANO",
      "postalCode": "20161",
      "street": "FRATELLI BELTRAMI",
      "streetNumber": 21,
      "streetNumberExtension": "A",
      "yCoordinate": 0.1,
      "xCoordinate": 0.1,
      "toponym": "VIA"
    },
  "contacts": [
    {
      "extension": {
        "myFieldName": "myValue"
      },
      "code": "cell",
      "contact": "345678888888",
      "type": {
        "code": "PHONE",
        "description": "Phone"
      }
    }
  ],
  "meters": [
    {
      "extension": {
        "myFieldName": "myValue"
      },
      "acronym": "acr",
      "brand": {
        "extension": {},
        "code": "SIEMENS",
        "description": "SIEMENS"
      }, 
      "productionYear": 1987
      "location": {
        "extension": {},
        "code": "2",
        "description": "EXTERNAL"
      },
      "type": {
        "extension": {},
        "code": "2",
        "description": "DIGITAL"
      },
      "serialNumber": "re445666",
      "class": {
        "extension": {},
        "code": "CONV",
        "description": "Converter"
      },
      "note": "note...",
      "active": true
    }
  ]
}

{
  "type": "about:blank",
  "title": "Not Found",
  "status": 404,
  "detail": "External system string does not exist",
  "instance": "/integration/assets/r1/accounts",
  "code": "IA001_001"
}

 Response error codes