Versions Compared

Old Version 39

changes.mady.by.user Karis Hathaway

Saved on

compared with

New Version 40

changes.mady.by.user Karis Hathaway

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Published by Scroll Versions from this space and version 2.1.4.7

...

Code Block
languagesql
SELECT * FROM CABLESCABLE;

Lists

When doing an INSERT or UPDATE for Cable records, it is sometimes necessary to provide values that exist elsewhere in the system. The LIST method can help to retrieve available options for these values.

...

Type

Description

Extra Parameters*

ResultsSearchable


PATH_STATUS

Retrieve Path Statuses


no

Results

*Extra Parameters can be appended to the URL in standard Query String fashion.

Anchor
Results
Results
Path Status Results

...

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>

...

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.PATHS.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  Toggle cloak Cloak Insert excerptAPIAPInopaneltrue
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.
Lists

Status of the Cable Path.
Sample Request
Call:
 Code Block
languagephp
POST DOMAIN/KEY/cable.PATHS.json
Headers:
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
...
Key
Value
service
5437
status
wired
Results Toggle cloak
...
If the request is successful, the RECID of the Cable Path 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>
}
Cable Path App Record
Image Modified
Cable Path Legs
Cable Path Legs can be easily updated or added. If multiple Cable Path Legs need to be added or updated, then separate POST requests will need to be made for each Path Leg.
...
 Code Block
languagephp
http://DOMAIN/api/API_KEY/cable.PATH_LEGS.OUTPUT

Available Fields
String
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*
"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
...
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>
}
Cable Path Leg App Record
Image Modified
Locating Cable Data
Within PCR-360, these menu options lists a variety of Grids that can be used to help locate any of the required fields.
...