Map_Cable_Extended_Data

Seitenverzeichnis:

shd.map_cable_extended_data.create

Beschreibung

Erstellen von erweiterten Kabel-Daten zu einer Map.

Parameter

Parameter	Typ	Beschreibung	Version
map_id	int	ID der verlinkten Map.	ab Version 2024.1.0
cable_id	int	Objekt-ID des verlinkten Kabels.	ab Version 2024.1.0
cable_data	string	Erweiterte Kabeldaten (bspw. im JSON-Format)	ab Version 2024.1.0

Rückgabewert

Wert	Typ	Version
message	string	ab Version 2024.1.0
response	int	ab Version 2024.1.0
current_date	string	ab Version 2024.1.0

Beispiel

Beispielaufruf

Beispielantwort

{
    "method": "shd.map_cable_extended_data.create",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "2",
        "cable_id": "1",
        "cable_data": "{some_json_data: true}",
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "message": "map_cable_extended_data.create.success",
        "response": 5,
        "current_date": "2024-01-05"
    }
}

shd.map_cable_extended_data.read

Beschreibung

Auslesen von erweiterten Kabel-Daten zu einer Map.

Parameter

Parameter	Typ	Beschreibung	Version
map_id	int	Optional: ID der verlinkten Map	ab Version 2024.1.0
cable_id	int	Optional: Objekt-ID des verlinkten Kabels	ab Version 2024.1.0

Rückgabewert

Wert	Typ	Version
id	int	ab Version 2024.1.0
map_id	int	ab Version 2024.1.0
cable_id	int	ab Version 2024.1.0
cable_data	string	ab Version 2024.1.0

Beispiel

Beispielaufruf

Beispielantwort

{
    "method": "shd.map_cable_extended_data.read",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "2",
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": [
        {
            "id": "4",
            "map_id": "10",
            "cable_id": "660753",
            "cable_data": "{json: true}"
        }
    ]
}

shd.map_cable_extended_data.update

Beschreibung

Bearbeiten von erweiterten Kabel-Daten zu einer Map.

Parameter

Typ

Beschreibung

Version

map_id

int

Optional: ID der verlinkten Map

Hinweis: Es muss mindestens die map_id oder die cable_id gesetzt werden.

ab Version 2024.1.0

cable_id

int

Optional: Objekt-ID des verlinkten Kabels

Hinweis: Es muss mindestens die map_id oder die cable_id gesetzt werden.

ab Version 2024.1.0

cable_data

string

Erweiterte Kabeldaten (bspw. im JSON-Format)

ab Version 2024.1.0

Rückgabewert

Wert	Typ	Version
message	string	ab Version 2024.1.0
response	bool	ab Version 2024.1.0
current_date	string	ab Version 2024.1.0

Beispiel

Beispielaufruf

Beispielantwort

{
    "method": "shd.map_cable_extended_data.update",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "2",
        "cable_id": "1",
        "cable_data": "{some_json_data: true}",
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "message": "map_cable_extended_data.update.success",
        "response": true,
        "current_date": "2024-01-05"
    }
}

shd.map_cable_extended_data.delete

Beschreibung

Löschen von erweiterten Kabel-Daten zu einer Map.

Parameter

Typ

Beschreibung

Version

map_id

int

Optional: ID der verlinkten Map

Hinweis: Es muss mindestens die map_id oder die cable_id gesetzt werden.

ab Version 2024.1.0

cable_id

int

Optional: Objekt-ID des verlinkten Kabels

Hinweis: Es muss mindestens die map_id oder die cable_id gesetzt werden.

ab Version 2024.1.0

Rückgabewert

Wert	Typ	Version
message	string	ab Version 2024.1.0
response	bool	ab Version 2024.1.0
current_date	string	ab Version 2024.1.0

Beispiel

Beispielaufruf

Beispielantwort

{
    "method": "shd.map_cable_extended_data.delete",
    "params": {
        "apikey": "24174j3tqj",
        "map_id": "2",
        "cable_id": "1",
        "language": "en"
    },
    "id": 1,
    "version": "2.0"
}

{
    "id": "1",
    "jsonrpc": "2.0",
    "result": {
        "message": "map_cable_extended_data.delete.success",
        "response": true,
        "current_date": "2024-01-05"
    }
}