Voice Line Related REST

Retrieve All Voice Lines on an ONT

Definition

URL	https://<emsserver>:8081/oam/oam-bin
prefix	voiceLine
action	show
tid	The name of the OLT (TID).
aid	AID of the ONT: Format: MDS1-<slot>-<pon>-<ont> Example: MDS1-1-1-3
filter	[ { "aid": "" } ]
attributes	N/A

Example Request

JSON

{
    "prefix": "voiceLine",
    "action": "show",
    "tid": "FF-ESU32-138.81",
    "aid": "MDS1-1-1-14",
    "filter": [
        {
            "aid": ""
        }
    ]
}

Example Response

JSON

{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "aid": "CS1-1-1-14-1"
        },
        {
            "aid": "CS1-1-1-14-2"
        }
    ]
}

Retrieve Voice Line Configuration

Definition

URL	https://<emsserver>:8081/oam/oam-bin
prefix	voiceLine
action	show
tid	The name of the OLT (TID).
aid	AID of the Voice Line: Format: CS1-<slot>-<pon>-<ont>-<uni> Example: CS1-1-1-14-1
filter	N/A
attributes	N/A

Example Request

JSON

{
    "prefix": "voiceLine", 
    "action": "show",
    "tid": "FF-ESU32-138.81",
    "aid": "CS1-1-1-14-1"
}

Example Response

JSON

{
    "response": {
        "code": 0,
        "description": ""
    },
    "result": [
        {
            "tid": "FF-ESU32-138.81",
            "aid": "CS1-1-1-14-1",
            "physicalLocation": "1-1-1-14-2-1",
            "description": "Pat",
            "idAddressOfRecord": "sip:2012030106@10.20.70.201",
            "idUserName": "2012030106",
            "idPassword": "1234",
            "idContactUriUser": "2012030106",
            "tcfgPortServiceName": "Meta-Services",
            "tcfgPortCallFeatureName": "Meta-Features",
            "adminState": 1
        }
    ]
}

Edit Voice Line Configuration

This Does Not Work!

Definition

URL	https://<emsserver>:8081/oam/oam-bin
prefix	voiceLine
action	edit
tid	The name of the OLT (TID).
aid	AID of the Voice Line: Format: CS1-<slot>-<pon>-<ont>-<uni> Example: CS1-1-1-14-1
filter	N/A
attributes	A JSON formatted array of attribute-value pairs, specifying the data to edit. Format: [ { "attr1" : "attr1-str-value" } , { "attr2" : attr2-num-value } , ... ] Example: [ { "adminState" : 1 } , { "description" : "Bob Williams" } , {"tcfgPortServiceName" : "Std-Voice-Services"} ]

Example Request

JSON

{
    "prefix": "voiceLine",
    "action": "edit",
    "tid": "FF-ESU32-138.81",
    "aid": "CS1-1-1-14-1",
    "attributes": [
        {
            "adminState": 1
        },
        {
            "description": "Pat"
        },
        {
            "idAddressOfRecord": "sip:2012030106@10.20.70.201"
        },
        {
            "idContactUriUser": "2012030106"
        },
        {
            "idUserName": "2012030106"
        },
        {
            "idPassword": "1234"
        },
        {
            "tcfgPortServiceName": "Meta-Services"
        },
        {
            "tcfgPortCallFeatureName": "Meta-Features"
        }
    ]
}

Example Response

JSON

{
    "response": {
        "code": "9999",
        "description": "Command execution failed",
        "result": "CLI doService ServletException: java.lang.reflect.InvocationTargetException"
    }
}