Versions Compared

Old Version 3

changes.mady.by.user Ribbon Communications

Saved on

compared with

New Version Current

changes.mady.by.user Ribbon Communications

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

REST API Method: POST /rest/linecard/{identifier}/telcods1port/{identifier}

telcods1port - REST API Methods
Page Tree
rootResource - telcods1port

Modifies a DS1 Port given a specific Table ID in a given Line Card.

Note
titleImportant Note

This API should not be used to modify the port type. Port type modification must be done in groups of ports via the DS1 Port Group.

URL:

https://

...

192.

...

168.

...

0.

...

111/rest/linecard/{identifier}/telcods1port/{identifier}

HTTP Method

POST

Requires Authentication:

true

Noprint
Panel
bgColortransparent
titleBGColor#DDD
title[telcods1port - REST API Methods|Resource - telcods1port]

Page Tree
root@parent

Parameters

Parameter Name Required Service Affecting Data Type Default Value Possible Values Description
ConfigIEStateNoYesEnum1Possible values:
  • 0 - esDISABLED
  • 1 - esENABLED
Specifies the Administrative State of the resource.
PortNameYesNostringnone128 - Max LengthSpecifies the string name of the Port.
PortAliasNoNostringnone20 - Max LengthSpecifies an alias name for the port for easy identification.
PortDescriptionNoNostringnone128 - Max LengthSpecifies a description for easy identification when being selected in Signaling Groups
PortPhysicalTypeYesYesEnum1Possible values:
  • 0 - pptE1
  • 1 - pptT1
Specifies the physical type of port.
PortSignalingTypeYesYesEnum0Possible values:
  • 0 - pstISDN
  • 1 - pstCAS
Specifies the signaling type of the port.
PortFramingTypeYesYesEnum0Possible values:
  • 0 - pftESF
  • 1 - pftD4
  • 2 - pftCRC4
  • 3 - pftNOCRC4
Specifies the framing type for T1 ports.
PortCodingTypeYesYesEnum0Possible values:
  • 0 - pctB8ZS
  • 1 - pctAMI
  • 2 - pctHDB3
Specifies the line coding for the port.
PortLineBuildoutYesYesEnum0Possible values:
  • 0 - plbShortHaul
  • 1 - plbLongHaul
Specifies the trunk type for T1 ports.
PortShorthaulCablelengthYesYesEnum0Possible values:
  • 0 - psc133
  • 1 - psc266
  • 2 - psc394
  • 3 - psc533
  • 4 - psc655
 Specifies the cable length for T1 ports set to Short Haul Trunk Type.
Info

This option is only available for T1 ports set to a Short Haul Trunk Type.

PortLonghaultxAttenuationYesYesEnum3Possible values:
  • 0 - pla15dB
  • 1 - pla22point5dB
  • 2 - pla7point5dB
  • 3 - pla0dB
 Specifies the attenuation for T1 ports to Long haul trunk type.
Info

This option is only available for T1 ports set to a Long Haul Trunk Type.

PortLoopbackTypeYesYesEnum4Possible values:
  • 0 - pltLocal
  • 1 - pltRemote
  • 2 - pltLine
  • 3 - pltPayload
  • 4 - pltNone
Controls the loop back status of the port.
PortCRCTypeYesYesEnum1Possible values:
  • 0 - pctOff
  • 1 - pctOn
Specifies the CRC setting for E1 ports.

Tip
titleHelpful Tip

The POST can contain either only the attributes that are being updated, or the full set of attributes for the resource

...

Usage Example: (about cURL | requires a session token)

Code Block
languagebash
Put code example here

Response:

...

languagehtml/xml

...