All Endpoints - EXAMPLE ALL IN ONE

POST /ext/line/create

v2.0.9-2 - updated available request body params - include bouquets list

POST BODY

{
    "username": "larry_line",
    "password": "12345",
    "package": 107,
    "reseller_notes": "larry's home line",
    "bouquets": [2]
    "rid": "xDg456Hdfjdeg45"
}

Request parameters

Name	Requirements	Note
username	Optional, string, max 255	If not provided - random string will be generated
password	Optional, string, max 255	If not provided - random string will be generated
package	Required, integer
reseller_notes	Optional, string
mac_addr	Optional, string, valid MAC address format	If provided - the created record will be Device
max_connections	Optional, integer	If provided - will override the value in the package
bouquets	Optional, array of integers	!!! Bouquets that are not part of the selected package will not be added to the created line If not provided all bouquets in the selected package will be added to the created line
rid	Optional, Unique string	parameter is supplied to ensure action not performed multiple times

Response

{
    "line_id": "1734da33-9723-4df6-90d1-38dc589aa0ec",
    "expire_at": "2021-12-16T23:42:49+00:00",
    "transaction_amount": -100,
    "rid": "xDg456Hdfjdeg45"
}

---

GET /ext/line/find?username=&password=

• Required: username, password

Response

{
    "line_id": "1734da33-9723-4df6-90d1-38dc589aa0ec"
}

---

POST /ext/line/{{line-uuid}}/renew (line_id)

POST BODY

{
    "package": 108,
    "rid": "hfd5774466Gdhut"
}

• Optional: package, rid

rid parameter is supplied to ensure action not performed multiple times

Response

{
    "line_id": "1734da33-9723-4df6-90d1-38dc589aa0ec",
    "expire_at": "2021-12-16T23:42:49+00:00",
    "transaction_amount": -100,
    "rid": "hfd5774466Gdhut"
}

---

POST /ext/line/{{line-uuid}}/enable

Set the status, of the selected line, to enabled

Response

{
    "line_id": "1734da33-9723-4df6-90d1-38dc589aa0ec"
}

---

POST /ext/line/{{line-uuid}}/disable

Set the status, of the selected line, to disabled

Response

{
    "line_id": "1734da33-9723-4df6-90d1-38dc589aa0ec"
}

---

POST /ext/line/{{line-uuid}}/terminate

Delete the selected line

Response

{
    "line_id": "1734da33-9723-4df6-90d1-38dc589aa0ec"
}