...
| No Format |
|---|
GET http://DOMAIN/api/API_KEY/cable.OUTPUT?LIST=LISTTYPE&SEARCH=test |
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.
...
| No Format |
|---|
<cable>
<status>success</status>
<page>1</page>
<count>20</count>
<total_count>20</total_count>
<path_status>
<item><item>
<RECID>98</RECID>
<VALUE>Wired</VALUE>
</item>
</path_status>
</cable> |
...
| No Format |
|---|
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:
| No Format |
|---|
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:
| No Format |
|---|
{
<status>success</status><status>success</status>
<page>1</page><page>1</page>
<count>1</count><count>1</count>
<total_count>1<<total_count>1</total_count>count>
<cable>58337</cable><cable>58337</cable>
} |
Cable Path App Record
Cable Path Legs
...
| No Format |
|---|
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_location | no | Integer | RECID of the Location 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_location | no | Integer | RECID of the Location 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:
| No Format |
|---|
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:
| No Format |
|---|
{]
<status>success</status><status>success</status>
<page>1</page><page>1</page>
<count>1</count><count>1</count>
<total_count>1<<total_count>1</total_count>count>
<cable>58337</cable><cable>58337</cable>
} |
Cable Path Leg App Record
...