| Table of Contents | ||||
|---|---|---|---|---|
|
Read Call
Reading Data
In an effort to make the PCR-360 API more flexible, PCR has made the decision to no longer create individual endpoints for all the different data types. Instead, PCR is encouraging Users to use the SQL endpoint with a structured SELECT statement to retrieve exactly the data you want. Please see the SQL End Point documentation for more information.
...
| Code Block | ||
|---|---|---|
| ||
SELECT * FROM CABLE; |
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.
...
| Code Block | ||
|---|---|---|
| ||
GET http://DOMAIN/api/API_KEY/cable.OUTPUT?LIST=LISTTYPE |
Searchable
If a LISTTYPE is designated as searchable in the table below, adding the "SEARCH" param will return values that contain the provided value.
...
Parameter | Replace With |
|---|---|
LISTTYPE | The type of List to be retrieved. Types can be found below. |
List Types
Type | Description | Extra Parameters* | Searchable | |
|---|---|---|---|---|
PATH_STATUS | Retrieve Path Statuses | no |
*Extra Parameters can be appended to the URL in standard Query String fashion.
| Anchor | ||||
|---|---|---|---|---|
|
| Code Block | ||||
|---|---|---|---|---|
| ||||
<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 | ||
|---|---|---|
| ||
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 | Status of the Cable Path. |
Sample Request
Call:
| Code Block | ||
|---|---|---|
| ||
POST DOMAIN/KEY/cable.PATHS.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
|---|---|
service | 5437 |
status | wired |
Results
If the request is successful, the RECID of the Cable Path is returned as follows:
| Code Block | ||||
|---|---|---|---|---|
| ||||
{
<status>success</status>
<page>1</page>
<count>1</count>
<total_count>1</total_count>
<cable>58337</cable>
} |
Cable Path App Record
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 | ||
|---|---|---|
| ||
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 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. |
Sample Request
Call:
| Code Block |
|---|
POST DOMAIN/KEY/cable.PATH_LEGS.json |
Headers:
Key | Value |
|---|---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
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 | ||||
|---|---|---|---|---|
| ||||
{
<status>success</status>
<page>1</page>
<count>1</count>
<total_count>1</total_count>
<cable>58337</cable>
} |
Cable Path Leg App Record
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.
...