API to manage users, Login users, Create, Delete and update users
This method is used to get the user details from table.
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { first_name:"kumar", middle_name:"", last_name:"test, vessel_name:"", mailing_address:"", email: "test@gmail.com", phone:"5567778988", alternate_phone:"", vhf_channel:"", sat_phone:"", iridium_phone:"", category:"", role:"", company_name:"", secondary_first_name:"", secondary_phone:"", secondary_mailing_address:"", tertiary_first_name:"", tertiary_phone:"", tertiary_mailing_address:"", registered_number:"", nmfs_number:"", license_number:"", landing_port:"", country:"USA", city:"Alaska", state:"Alaska", address1:"112, Alaska", address2:"112, Alaska", zip:"600009", primary_office_number:"", status:"" } |
Status: 202 - Success
This method is used for Login.
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { first_name:"kumar", middle_name:"", last_name:"test, vessel_name:"", mailing_address:"", email: "test@gmail.com", phone:"5567778988", alternate_phone:"", vhf_channel:"", sat_phone:"", iridium_phone:"", category:"", role:"", company_name:"", secondary_first_name:"", secondary_phone:"", secondary_mailing_address:"", tertiary_first_name:"", tertiary_phone:"", tertiary_mailing_address:"", registered_number:"", nmfs_number:"", license_number:"", landing_port:"", country:"USA", city:"Alaska", state:"Alaska", address1:"112, Alaska", address2:"112, Alaska", zip:"600009", primary_office_number:"", status:"" } |
Status: 202 - Success
This method is used to create new user.
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { first_name:"kumar", middle_name:"", last_name:"test, vessel_name:"", mailing_address:"", email: "test@gmail.com", phone:"5567778988", alternate_phone:"", vhf_channel:"", sat_phone:"", iridium_phone:"", category:"", role:"", company_name:"", secondary_first_name:"", secondary_phone:"", secondary_mailing_address:"", tertiary_first_name:"", tertiary_phone:"", tertiary_mailing_address:"", registered_number:"", nmfs_number:"", license_number:"", landing_port:"", country:"USA", city:"Alaska", state:"Alaska", address1:"112, Alaska", address2:"112, Alaska", zip:"600009", primary_office_number:"", status:"" } |
Status: 202 - Success
This method is used to delete the existing user.
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { first_name:"kumar", middle_name:"", last_name:"test, vessel_name:"", mailing_address:"", email: "test@gmail.com", phone:"5567778988", alternate_phone:"", vhf_channel:"", sat_phone:"", iridium_phone:"", category:"", role:"", company_name:"", secondary_first_name:"", secondary_phone:"", secondary_mailing_address:"", tertiary_first_name:"", tertiary_phone:"", tertiary_mailing_address:"", registered_number:"", nmfs_number:"", license_number:"", landing_port:"", country:"USA", city:"Alaska", state:"Alaska", address1:"112, Alaska", address2:"112, Alaska", zip:"600009", primary_office_number:"", status:"" } |
Status: 202 - Success
This method is used to update the user details.
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { first_name:"kumar", middle_name:"", last_name:"test, vessel_name:"", mailing_address:"", email: "test@gmail.com", phone:"5567778988", alternate_phone:"", vhf_channel:"", sat_phone:"", iridium_phone:"", category:"", role:"", company_name:"", secondary_first_name:"", secondary_phone:"", secondary_mailing_address:"", tertiary_first_name:"", tertiary_phone:"", tertiary_mailing_address:"", registered_number:"", nmfs_number:"", license_number:"", landing_port:"", country:"USA", city:"Alaska", state:"Alaska", address1:"112, Alaska", address2:"112, Alaska", zip:"600009", primary_office_number:"", status:"" } |
Status: 202 - Success
API to manage get node, create node, delete node, update and action
This method is used to get the node details from table.
Creates a Node
A sample response below
{ “status”: “success”, “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “attrs”: { “__name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "user_id": "1", "version": "1", "node_name": "my amf node", "node_type": "amf", "site_id": 1, "attr": [ { "plmn_id": { "mcc": "941", "mnc": "70" }, "network_name": { "full": "5Gcore", "amf_name": "5g-amf0" } } ] } |
Status: 202 - Success
This method is used to create new node.
Delete a Node
A sample response below
{ “status”: “success”
}
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "user_id": "1", "version": "1", "node_name": "user_amf_node", "node_id": 1, "site_id": 1 } |
Status: 202 - Success
This method is used to create new user.
Gets details of All nodes for logged in user
A user may have multiple sites, each site means full 5g core. Mostly it will be 1 site per user. But site_id is being used to scale for future.
Each site will have multiple nodes (5g nodes like amf, smf etc), if node_id parameter (optional) included then node specific details will be returned otherwise node details for all will be returned
A sample response below { “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “attrs”: { “name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } }, { “node_id”: 2, “node_name”: “user_smf_node”, “node_type”: “smf”, “attrs”: { “name”: “smf.localhost!smf”, “active”: true, “host_name”: “smf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100" } |
Status: 202 - Success
This method is used to update the existing node(s).
Perform a action node, e.g. start, stop, restart
A sample response below
{ “status”: “success”, “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “attrs”: { “__name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "user_id": "1", "version": "1", "node_name": "user_amf_node", "node_type": "amf", "node_id": 1, "site_id": 1, "action": "restart" } |
Status: 202 - Success
This method is used to perform an action on the existing node.
Update a Node
A sample response below
{ “status”: “success”, “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “my_amf_node”, “node_type”: “amf”, “attrs”: { “__name”: “amf.localhost!amf”, “active”: true, “host_name”: “amf.localhost”, “last_check”: 1601787004.907195, “performance_data”: [ “procs=1;250;1:;0;” ] } } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "user_id": "1", "version": "1", "node_name": "my_amf_node", "node_type": "amf", "node_id": 1, "site_id": 1 } |
Status: 202 - Success
API to manage subscriber management, N6 related measurements, PCF and UDM Measurements
This method is used to get node KPIs.
Get KPI collection status
A sample response below
{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_smf_node”, “node_type”: “smf”, “kpi_status”: “active” }, { “node_id”: 2, “node_name”: “user_smf_node”, “node_type”: “smf”, “kpi_status”: “active” } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_id": [ 1, 2 ] } |
Status: 202 - Success
This method is used to get list of available KPIs for a node.
Gets KPIS of All nodes or selected node for logged in user
A user may have multiple sites, each site means full 5g core. Mostly it will be 1 site per user. But site_id is being used to scale for future.
Each site will have multiple nodes (5g nodes like amf, smf etc), if node_id parameter (optional) included then node specific KPI details will be returned otherwise node details for all will be returned
A sample response below { “results”: [ { “site_id”: “1”, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “from_date”: “1601879960123”, “to_date”: “1601869960123”, “time_zone”: “GMT -5”, “kpis”: [ { “Registered subscribers measurement”: “100”, “Mean number of registered subscribers”: “100”, “Maximum number of registered subscribers”: “100”, “Registration procedure related measurements”: “100”, “Number of initial registration requests “: “100”, “Number of successful initial registrations”: “100”, “Number of mobility registration update requests”: “100”, “Number of successful mobility registration updates”: “100”, “Number of periodic registration update requests”: “100”, “Number of successful periodic registration updates”: “100” } ] } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_id": 1 } |
Status: 202 - Success
This method is used to update available KPIs settings for collection.
Enable, Disable KPI collection
A sample response below
{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “kpi_status”: “active” } ] } ] } }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_id": 1, "kpi_status": "enable" } |
Status: 202 - Success
Monitoring via API for 5G core logs, Analytical and Monitoring system.
This method is used to update nodes log level.
Gets Log of selected node(s) for logged in user
A sample response below
{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “from_date”: “1601879960123”, “to_date”: “1601869960123”, “time_zone”: “GMT -5”, “log”: [ { “debug”: “Jason formatted log here” } ] } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_id": 1, "from_date": "1601879960123", "to_date": "1601869960123" } |
This method is used to get node log.
Get Log collection status
A sample response below
{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “log_status”: “active”, “log_level”: “DEBUG” } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_id": 1 } |
This method is used to update node(s) tracing.
Gets Trace of selected Interface(s) for logged in user
A sample response below
{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_ids”: [ 1, 2 ], “interface_nodes”: “amf-smf”, “interface”: “N1”, “from_date”: “1601879960123”, “to_date”: “1601869960123”, “time_zone”: “GMT -5”, “trace”: [ { “amf2smf”: “Jason formatted trace here” } ] } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_id": [ 1, 2 ], "interface": "N11", "from_date": "1601879960123", "to_date": "1601869960123" } |
Status: 202 - Success
This method is used to get node trace.
Enable, Disable Log collection
A sample response below
{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_id”: 1, “node_name”: “user_amf_node”, “node_type”: “amf”, “log_status”: “active”, “log_level”: “DEBUG” } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Get Log collection status
A sample response below
{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_ids”: [ 1, 2 ], “interface_nodes”: “amf-smf”, “interface”: “N11”, “trace_status”: “active” } ] } ] }
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_ids": [ 1, 2 ], "interface": "N11" } |
Status: 202 - Success
This method is used to get node trace.
Enable, Disable Trace collection
A sample response below
{ “results”: [ { “status”: “success”, “site_id”: 1, “node_data”: [ { “node_ids”: [ 1, 2 ], “interface_nodes”: “amf-smf”, “interface”: “N11”, “trace_status”: “active” } ] } ] }
// Lorem ipsum
// Lorem ipsum
// Lorem ipsum
network
->create("+15558675310", // to
"+15017122661", // from
array("url" => "http://demo.app.5gsoftware.com/docs/network.xml")
);
Get Log collection status
A sample response below
{ “results”: [ { “site_id”: 1, “node_data”: [ { “node_ids”: [ 1, 2 ], “interface_nodes”: “amf-smf”, “interface”: “N11”, “trace_status”: “active” } ] } ] }
Body Parameters
Name | Description |
---|---|
getuserdetails | { "version": "1", "user_id": "1", "site_id": "100", "node_ids": [ 1, 2 ], "interface": "N11", "trace_status": "enable" } |
Status: 202 - Success