Versions Compared

Old Version 7

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/fxscard/{identifier}/fxsport/{identifier}

Modifies a FXS Port given a specific ID.

URL:

https://192.168.0.111/rest/fxscard/{identifier}/fxsport/{identifier}

HTTP Method

POST

Requires Authentication:

true

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

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.
PortDescriptionNoNostringnone64 - Max LengthSpecifies a description for easy identification when being selected in Signaling Groups
RxGainYesYesint-6Possible values:
  • -11 - Minimum
  • 0 - Maximum
Specifies a relative gain adjustment in decibels based on the country profile selected.
TxGainYesYesint0Possible values:
  • -5 - Minimum
  • 5 - Maximum
Specifies a relative gain adjustment in decibels based on the country profile selected.
CountryYesYesint33Specifies the country profile to be used. One of the following: Australia (1), Austria (2), Belgium (3), Brazil (4), China (5), Czech Republic (6), Denmark (7), Finland (8), France (9), Germany (10), Switzerland (11), Greece (12), Hungary (13), India (14), Italy (15), Japan (16), Korea (17), Mexico (18), Netherlands (19), New Zealand (20), Nigeria (21), Norway (22), Portugal (23), Russia (24), Saudi Arabia (25), Slovakia (26), South Africa (27), Spain (28), Sweden (29), Taiwan (30), Turkey (31), United Kingdom (32), United States (33). Must be within the range of 1 to 33, 33 being the default.
LocalLoopTypeYesYesEnum0Possible values:
  • 0 - llLengthStandard
  • 1 - llLengthLong
Specifies FXS local loop type. Supported loop types are Standard for cable length of up to 1000 meters and Long for cable length of up to 3000 meters.

Tip
titleHelpful Tip

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