Calling saveCable using Cabling API Parameters

For full details of this API Endpoint, see Cabling API.

type

Data Type: String
Required Field: for Path Updates or Path Leg Updates

Notes:

"PATHS" is required to indicate that this will process a Cable Path record.
”PATH_LEGS” is required to indicate that this will process a Cable Path Leg record.

recid

Data Type: Integer
Required Field: for Updates
Required Type: “PATHS” or “PATH_LEGS”

Notes:

The RECID of the Cable Path, if type = “PATHS” or the Cable Path Leg if type = “PATH_LEGS”.

service

Data Type: Integer
Required Field: Yes*
Required Type: “PATHS” or “PATH_LEGS”

Notes:

RECID of the Service to assign to the Cable Path.

*Either a Service OR Location is required, but not both.

location

Data Type: Integer
Required Field: Yes*
Required Type: “PATHS” or “PATH_LEGS”

Notes:

RECID of the Location to assign to the Cable Path.

*Either a Service OR Location is required, but not both.

Or, if Type = “PATH_LEGS”, RECID of the Location of the Path Leg.

*Required if the Service that this Path Leg belongs to is a multi-location Service.

status

Data Type: Integer
Required Field: Yes
Required Type: “PATHS” or “PATH_LEGS”

Notes:

LISTS recid of the desired Status of the Cable Path.

from_equipment

Data Type: Integer
Required Field: No
Required Type: “PATH_LEGS”

Notes:

RECID of the Equipment that the Path Leg is coming from.

from_ppl

Data Type: Integer
Required Field: No
Required Type: “PATH_LEGS”

Notes:

RECID of the Port/Pin/Len that the Path Leg is coming from.

cable

Data Type: Integer
Required Field: No
Required Type: “PATH_LEGS”

Notes:

RECID of the Cable that the Path Leg is associated with.

pair_strand

Data Type: Integer
Required Field: Yes*
Required Type: “PATH_LEGS”

Notes:

RECID of the Pair/Strand that the Path Leg belongs to.

*Required if Cable is provided

to_equipment

Data Type: Integer
Required Field: No
Required Type: “PATH_LEGS”

Notes:

RECID of the Equipment that the Path Leg ends at.

to_ppl

Data Type: Integer
Required Field: No
Required Type: “PATH_LEGS”

Notes:

RECID of the Port/Pin/Len that the Path Leg ends at.

instance

Data Type: Integer
Required Field: Yes
Required Type: “PATH_LEGS”

Notes:

Instance number of the Path Leg.

path

Data Type: Integer
Required Field: Yes
Required Type: “PATH_LEGS”

Notes:

RECID of the Path that the Path Leg belongs on.

backbone_service

Data Type: Integer
Required Field: No
Required Type: “PATH_LEGS”

Notes:

RECID of the Backbone Service.

Add New Path Example

PHP

$params = [
    "recid" => 1, //Cable Path Leg recid of 1
    "location" => 1, //Location recird of 1
    "status" => 1, //Cable Status ID of 1
    "type" => “PATHS”
];

$api_call = $this->call('saveCable', $params, true)

Add New Path Legs Example

PHP

$params = [
    "recid" => 1, //Cable Path Leg recid of 1
    "service" => 1, //Service recird of 1
    "status" => 1, //Cable Status ID of 1
    "type" => “PATH_LEGS”,
    "from_equipment" => 1, //from Equipment recid of 1
    "from_ppl" => 1, //from PPL recid of 1
    "cable" => 1, //Cable recid of 1
    "pair_strand" => 1, //Pair/Strand recid of 1
    "to_equipment" => 2, //from Equipment recid of 2
    "to_ppl" => 1, //from PPL recid of 1
    "instance" => 3, //Instance recid of 3
    "path" => 1, //Path recid of 1
    "backbone_service" => 1 //Backbone Service recid of 1
];

$api_call = $this->call('saveCable', $params, true)