Versions Compared

Old Version 6

changes.mady.by.user Robert Sims

Saved on

compared with

New Version Current

changes.mady.by.user Bianca Rosa

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Scroll Health Check: The link has been rewritten to its master page by check 'P16'.

...

Type

Description

Extra Parameters*

Searchable

Results

PATH_STATUS

Retrieve Path Statusesno


Path Status Results

Toggle cloak
 Cloak

 Code Block
languagephp
linenumberstrue
    <cable>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <path_status>
            <item>
                <RECID>98</RECID>
                <VALUE>Wired</VALUE>
            </item>
        </path_status>
    </cable>


*Extra Parameters can be appended to the URL in standard Query String fashion.
...
...
Write Call
Cable Paths can be easily updated or added to a Service or Location. If multiple Cable Paths need to be added or updated, then a separate POST request will need to be made for each Path.
...
 Code Block
languagephp
http://DOMAIN/api/API_KEY/cable.OUTPUT
Available Fields
Field
Required
Data Type
Options
Default
Notes
recid
yes*
Integer


The RECID of the Cable Path. *Required only if attempting an UPDATE.
service
yes*
Integer


RECID of the Service to assign to the Cable Path. *Either a Service OR Location is required, but not both.
location
yes*
Integer


RECID of the Location to assign to the Cable Path. *Either a Service OR Location is required, but not both.
status
yes
Integer
Lists
Lists 
 Toggle cloak
 Cloak
 Insert excerpt
API
API
nopaneltrue


Status of the Cable Path.
typeyes*String

"type=PATHS" is required to indicate that this will process a Cable Path record. This can be added as a POST parameter or within the URI as shown below.
Sample Request
Call:
 Code Block
languagephp
POST DOMAIN/KEY/cable.json
...
 Code Block
languagephp
http://DOMAIN/api/API_KEY/cable.PATH_LEGS.OUTPUT

Available Fields
Field
Required
Data Type
Options
Default
Notes
recid
yes*
Integer


The RECID of the Cable Path Leg. *Required only if attempting an UPDATE.
from_equipment
no
Integer


RECID of the Equipment that the Path Leg is coming from.
from_ppl
no
Integer


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


RECID of the Cable that the Path Leg is associated with.
pair_strand
yes*
Integer


Recid RECID of the Pair/Strand that the Path Leg belongs to. *Required if Cable is provided.
to_equipment
no
Integer


RECID of the Equipment that the Path Leg ends at.
to_ppl
no
Integer


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


Instance number of the Path Leg.
path
yes
Integer


RECID of the Path that the Path Leg belongs on.
backbone_service
no
Integer


RECID of the Backbone Service.
location
yes*
Integer


RECID of the Location of the Path Leg. *Required if the Service that this Path Leg's belongs to is multi-location Service.
typeyes*String

"type=PATH_LEGS" is required to indicate that this is to process a Cable Path Leg record
Sample Request
Call:
 Code Block
POST DOMAIN/KEY/cable.PATH_LEGS.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
...
Key
Value
cable
58337
pair_strand
71
instance
1
path
927
Results
 Toggle cloak
 Cloak
If the request is successful, the RECID of the Cable Path Leg is returned as follows:
 Code Block
languagephp
linenumberstrue
{
    <status>success</status>
    <page>1</page>
    <count>1</count>
    <total_count>1</total_count>
    <cable>58337</cable>
}
...