### NAS Get System Preference Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the system preference setting. ```APIDOC ## NAS Get System Preference ### Description Retrieves the system preference setting. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Pref** (string) - The system preference value. - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### PDS Start Tracking Session Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Requests to start a tracking session for PDS. This is used to initiate location tracking. ```APIDOC ## PDS/Start Tracking Session Request ### Description Requests to start a tracking session for PDS. This is used to initiate location tracking. ### Method N/A (QMI Protocol) ### Endpoint N/A (QMI Protocol) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (N/A) N/A #### Response Example N/A ``` -------------------------------- ### WDS Get Default Settings Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the default settings configured in the WDS module. ```APIDOC ## WDS Get Default Settings Request ### Description Retrieves the default settings configured in the WDS module. ### Response #### Success Response (200) - **Profile Name** (string) - The name of the default profile. - **PDP Type** (string) - The Packet Data Protocol type. - **APN Name** (string) - The Access Point Name. - **Primary DNS** (string) - The primary DNS server address. - **Secondary DNS** (string) - The secondary DNS server address. - **UMTS Requested QoS** (object) - Requested Quality of Service for UMTS. - **UMTS Minimum QoS** (object) - Minimum Quality of Service for UMTS. - **GPRS Requested QoS** (object) - Requested Quality of Service for GPRS. - **GPRS Minimum QoS** (object) - Minimum Quality of Service for GPRS. - **Username** (string) - The username for authentication. ``` -------------------------------- ### WDS/Start Network Interface Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Response from starting a network interface, including packet data handle, call end reason, and result code. ```APIDOC ## WDS/Start Network Interface Response ### Description Response from starting a network interface, including packet data handle, call end reason, and result code. ### Response #### Success Response (200) - **Packet Data Handle** (integer) - The handle for packet data. - **Result Code** (integer) - The result code of the operation. - **Call End Reason** (integer) - The reason for call end. - **Verbose Call End Reason** (string) - A more detailed reason for call end. ``` -------------------------------- ### WDS Get Profile List Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves a list of all configured profiles from the WDS module. ```APIDOC ## WDS Get Profile List Request ### Description Requests a list of all profiles configured in the WDS module. ### Response #### Success Response (200) - **Profile List** (array) - A list containing details of each profile. ``` -------------------------------- ### NAS Get System Selection Pref Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves system selection preferences including emergency mode, mode, band, PRL, and roaming. ```APIDOC ## NAS Get System Selection Pref Response ### Description Retrieves system selection preferences. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. - **Emergency Mode** (string) - Emergency mode status. - **Mode** (string) - The system selection mode. - **Band** (string) - The selected band. - **PRL** (string) - Preferred Roaming List. - **Roaming** (string) - Roaming status. #### Response Example None ``` -------------------------------- ### WDS Get Profile Settings Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the detailed settings for a specific profile within the WDS module. ```APIDOC ## WDS Get Profile Settings Request ### Description Retrieves the settings for a specific profile in the WDS module. ### Response #### Success Response (200) - **Profile Name** (string) - The name of the profile. - **PDP Type** (string) - The Packet Data Protocol type. - **APN Name** (string) - The Access Point Name. - **Primary DNS** (string) - The primary DNS server address. - **Secondary DNS** (string) - The secondary DNS server address. - **UMTS Requested QoS** (object) - Requested Quality of Service for UMTS. - **UMTS Minimum QoS** (object) - Minimum Quality of Service for UMTS. - **GPRS Requested QoS** (object) - Requested Quality of Service for GPRS. - **GPRS Minimum QoS** (object) - Minimum Quality of Service for GPRS. - **Username** (string) - The username for authentication. - **Authentication** (string) - The authentication method. - **IP Address** (string) - The assigned IP address. - **P-CSCF** (string) - The P-CSCF address. ``` -------------------------------- ### NAS Get ACCOLC Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the ACCOLC value. ```APIDOC ## NAS Get ACCOLC Response ### Description Retrieves the ACCOLC (Access Control List) value. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **ACCOLC** (integer) - The ACCOLC value. - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### DMS Get Stored Firmware Info Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Requests information about a stored firmware image on the device. ```APIDOC ## DMS/Get Stored Firmware Info Request ### Description Requests information about a specific firmware image stored on the device. ### Request Body - **Image** (string) - The identifier of the firmware image to query. ``` -------------------------------- ### NAS Get Serving System Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves information about the serving system, including time zone and protocol revision. ```APIDOC ## NAS Get Serving System Response ### Description Retrieves the current serving system information. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Time Zone** (string) - The time zone of the serving system. - **Protocol Revision** (string) - The protocol revision of the serving system. #### Response Example None ``` -------------------------------- ### DMS Get Device Capabilities Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Provides the device's capabilities and the result code of the request. ```APIDOC ## DMS/Get Device Capabilities Response ### Description Returns the device's capabilities and the result code of the request. ### Response #### Success Response (200) - **Capabilities** (object) - An object containing the device's capabilities. - **Result Code** (integer) - The result of the operation. ``` -------------------------------- ### DMS Get Device Revision Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Provides the revision information for the device, including boot code and UQCN revisions, along with the result code. ```APIDOC ## DMS/Get Device Revision Response ### Description Returns the revision information for the device, including boot code and UQCN revisions, and the result code. ### Response #### Success Response (200) - **Revision** (string) - The main device revision. - **Result Code** (integer) - The result of the operation. - **Boot Code Revision** (string) - The revision of the boot code. - **UQCN Revision** (string) - The revision of the UQCN. ``` -------------------------------- ### NAS Get Preferred Networks Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the list of preferred and static networks. ```APIDOC ## NAS Get Preferred Networks Response ### Description Retrieves the list of preferred and static networks. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. - **Networks** (list) - A list of preferred networks. - **Static Networks** (list) - A list of static networks. #### Response Example None ``` -------------------------------- ### DMS Get Device Model Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Provides the model of the device and the result code of the request. ```APIDOC ## DMS/Get Device Model Response ### Description Returns the model of the device and the result code of the request. ### Response #### Success Response (200) - **Model** (string) - The model of the device. - **Result Code** (integer) - The result of the operation. ``` -------------------------------- ### DMS UIM Get Control Key Status Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Requests the status of the control key for the UIM card. ```APIDOC ## DMS/UIM Get Control Key Status Request ### Description Requests the current status of the control key for the UIM card. ### Request Body - **Facility** (string) - The facility for which to get the control key status. ``` -------------------------------- ### NAS Get Technology Preference Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the active and persistent technology preferences. ```APIDOC ## NAS Get Technology Preference Response ### Description Retrieves the active and persistent technology preferences. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. - **Active Preference** (string) - The active technology preference. - **Persistent Preference** (string) - The persistent technology preference. #### Response Example None ``` -------------------------------- ### WDS/Get Dormancy Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Dormancy responses, including Dormancy Status and Result Code. ```APIDOC ## WDS/Get Dormancy Response ### Description Retrieves the dormancy status of the connection. ### Fields - **Dormancy Status** (integer) - The current dormancy status. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### WDS/Get Current Settings Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Current Settings responses, such as IP Family, IM CN Flag, and Extended Technology. ```APIDOC ## WDS/Get Current Settings Response ### Description Provides details about the current settings for the WDS (Wireless Data Services) interface. ### Fields - **IP Family** (integer) - The IP family configuration. - **IM CN Flag** (integer) - Flag indicating IM CN status. - **Extended Technology** (integer) - Extended technology information. - **P-CSCF IPv6 Address List** (list) - List of P-CSCF IPv6 addresses. ``` -------------------------------- ### WDS/Get Active MIP Profile Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Active MIP Profile responses, including Index and Result Code. ```APIDOC ## WDS/Get Active MIP Profile Response ### Description Retrieves the index of the active Mobile IP (MIP) profile. ### Fields - **Index** (integer) - The index of the active MIP profile. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### WDS/Get Autoconnect Setting Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Autoconnect Setting responses, including Autoconnect, Roam, and Result Code. ```APIDOC ## WDS/Get Autoconnect Setting Response ### Description Retrieves the autoconnect settings for the data connection. ### Fields - **Autoconnect** (integer) - The autoconnect setting. - **Roam** (integer) - The roam setting. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### NAS Get Network Parameters Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves various network parameters including SCI, SCM, registration status, and roaming information. ```APIDOC ## NAS Get Network Parameters Response ### Description Retrieves various network parameters. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. - **SCI** (string) - System Code Identifier. - **SCM** (string) - System Code Mask. - **Registration** (string) - Registration status. - **CDMA 1xEV-DO Revision** (string) - CDMA 1xEV-DO revision. - **CDMA 1xEV-DO SCP Custom** (string) - Custom SCP settings for CDMA 1xEV-DO. - **Roaming** (string) - Roaming status. #### Response Example None ``` -------------------------------- ### NAS Get Home Network Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves home network information, including home IDs and extended home network details. ```APIDOC ## NAS Get Home Network Response ### Description Retrieves information about the home network. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Home Network** (string) - The home network identifier. - **Result Code** (integer) - The result code of the operation. - **Home IDs** (list) - A list of home network IDs. - **Extended Home Network** (string) - Extended home network information. #### Response Example None ``` -------------------------------- ### WDS/Get Modem Info Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Modem Info responses, including Status, Call End Reason, TX Bytes, RX Bytes, Dormancy Status, Technology, Rates, Previous TX Bytes, Previous RX Bytes, Active Duration, and Result Code. ```APIDOC ## WDS/Get Modem Info Response ### Description Retrieves detailed information about the modem. ### Fields - **Result Code** (integer) - The result code of the operation. - **Status** (integer) - The current status of the modem. - **Call End Reason** (integer) - The reason for the last call end. - **TX Bytes** (integer) - The number of bytes transmitted. - **RX Bytes** (integer) - The number of bytes received. - **Dormancy Status** (integer) - The dormancy status of the modem. - **Technology** (integer) - The current data bearer technology. - **Rates** (integer) - The current data rates. - **Previous TX Bytes** (integer) - The number of bytes transmitted in the previous session. - **Previous RX Bytes** (integer) - The number of bytes received in the previous session. - **Active Duration** (integer) - The active duration of the current session. ``` -------------------------------- ### WDS/Get MIP Parameters Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get MIP Parameters responses, including Mobile IP Mode, Retry Attempt Limit, Retry Attempt Interval, Re-Registration Period, Re-Registration Only With Traffic, MN-HA Authenticator Calculator, MN-HA RFC 2002 BIS Authentication, and Result Code. ```APIDOC ## WDS/Get MIP Parameters Response ### Description Retrieves the parameters for Mobile IP (MIP). ### Fields - **Result Code** (integer) - The result code of the operation. - **Mobile IP Mode** (integer) - The Mobile IP mode. - **Retry Attempt Limit** (integer) - The limit for retry attempts. - **Retry Attempt Interval** (integer) - The interval between retry attempts. - **Re-Registration Period** (integer) - The period for re-registration. - **Re-Registration Only With Traffic** (integer) - Flag indicating re-registration only with traffic. - **MN-HA Authenticator Calculator** (integer) - MN-HA authenticator calculation method. - **MN-HA RFC 2002 BIS Authentication** (integer) - MN-HA RFC 2002 BIS authentication method. ``` -------------------------------- ### WDS/Get MIP Profile Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get MIP Profile responses, including State, Home Address, Primary Home Agent Address, Secondary Home Agent Address, Reverse Tunneling, NAI, HA SPI, AAA SPI, HA State, AAA State, and Result Code. ```APIDOC ## WDS/Get MIP Profile Response ### Description Retrieves the details of a Mobile IP (MIP) profile. ### Fields - **Result Code** (integer) - The result code of the operation. - **State** (integer) - The state of the MIP profile. - **Home Address** (string) - The home address for the MIP profile. - **Primary Home Agent Address** (string) - The primary home agent address. - **Secondary Home Agent Address** (string) - The secondary home agent address. - **Reverse Tunneling** (integer) - The reverse tunneling setting. - **NAI** (string) - The Network Access Identifier (NAI). - **HA SPI** (integer) - The Home Agent Security Parameter Index (SPI). - **AAA SPI** (integer) - The Authentication, Authorization, and Accounting (AAA) SPI. - **HA State** (integer) - The state of the Home Agent. - **AAA State** (integer) - The state of the AAA connection. ``` -------------------------------- ### WDS/Get Call List Max Size Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Call List Max Size responses, including Maximum and Result Code. ```APIDOC ## WDS/Get Call List Max Size Response ### Description Retrieves the maximum size allowed for the call list. ### Fields - **Maximum** (integer) - The maximum number of calls that can be stored. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### WDS/Get MIP Mode Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get MIP Mode responses, including Mobile IP Mode and Result Code. ```APIDOC ## WDS/Get MIP Mode Response ### Description Retrieves the current Mobile IP (MIP) mode settings. ### Fields - **Mobile IP Mode** (integer) - The current Mobile IP mode. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### WDS/Get Modem Status Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Modem Status responses, including Status, Call End Reason, TX Bytes, RX Bytes, Dormancy Status, Technology, Rates, and Result Code. ```APIDOC ## WDS/Get Modem Status Response ### Description Retrieves the current status of the modem. ### Fields - **Status** (integer) - The current status of the modem. - **Call End Reason** (integer) - The reason for the last call end. - **TX Bytes** (integer) - The number of bytes transmitted. - **RX Bytes** (integer) - The number of bytes received. - **Dormancy Status** (integer) - The dormancy status of the modem. - **Technology** (integer) - The current data bearer technology. - **Rates** (integer) - The current data rates. - **Previous TX Bytes** (integer) - The number of bytes transmitted in the previous session. - **Previous RX Bytes** (integer) - The number of bytes received in the previous session. - **Active Duration** (integer) - The active duration of the current session. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### Build Gobi API for x86 Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_2012-07-12-1036/Readme.txt Use this command to build the Gobi API for x86 architecture. ```bash make ``` -------------------------------- ### Build Gobi API for Android Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_2012-07-12-1036/Readme.txt Use this command to build the Gobi API for Android. Ensure you provide the correct path to your Android toolchain. ```bash make Android ANDROID_PATH= ``` -------------------------------- ### WDS Get DNS Setting Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details the response codes for the WDS Get DNS Setting operation, including the result code, primary and secondary DNS settings (IPv4 and IPv6). ```APIDOC ## WDS/Get DNS Setting Response ### Description Provides the result code and DNS settings (IPv4 and IPv6) for a DNS setting query. ### Response #### Success Response (200) - **Result Code** (integer) - The result of the operation. - **Primary** (string) - The primary DNS server address. - **Secondary** (string) - The secondary DNS server address. - **Primary IPv6** (string) - The primary IPv6 DNS server address. - **Secondary IPv6** (string) - The secondary IPv6 DNS server address. ``` -------------------------------- ### NAS Get PLMN Name Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the PLMN name. ```APIDOC ## NAS Get PLMN Name Response ### Description Retrieves the PLMN (Public Land Mobile Network) name. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. - **Name** (string) - The PLMN name. #### Response Example None ``` -------------------------------- ### NAS Set System Selection Pref Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Sets the system selection preference. ```APIDOC ## NAS Set System Selection Pref Response ### Description Sets the system selection preference. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### NAS Get DDTM Preference Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the DDTM preference. ```APIDOC ## NAS Get DDTM Preference Response ### Description Retrieves the DDTM (Data Device Transfer Mode) preference. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **DDTM** (string) - The DDTM preference value. - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### WDS Create Profile Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Creates a new profile within the WDS module. ```APIDOC ## WDS Create Profile Request ### Description Creates a new profile in the WDS module. ### Response #### Success Response (200) - **Profile Identifier** (integer) - The identifier of the newly created profile. ``` -------------------------------- ### NAS Get Forbidden Networks Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the list of forbidden networks. ```APIDOC ## NAS Get Forbidden Networks Response ### Description Retrieves the list of forbidden networks. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. - **Networks** (list) - A list of forbidden networks. #### Response Example None ``` -------------------------------- ### NAS Get CSP PLMN Mode Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the CSP PLMN mode. ```APIDOC ## NAS Get CSP PLMN Mode Response ### Description Retrieves the CSP (Customer Specific PLMN) mode. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. - **Mode** (string) - The CSP PLMN mode. #### Response Example None ``` -------------------------------- ### WDS/Get Profile Settings Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Response containing the settings for a specific profile, including name, PDP type, APN, DNS, QoS, username, authentication, IP address, and P-CSCF. ```APIDOC ## WDS/Get Profile Settings Response ### Description Response containing the settings for a specific profile, including name, PDP type, APN, DNS, QoS, username, authentication, IP address, and P-CSCF. ### Response #### Success Response (200) - **Result Code** (integer) - The result code of the operation. - **Profile Name** (string) - The name of the profile. - **PDP Type** (string) - The Packet Data Protocol type. - **APN Name** (string) - The Access Point Name. - **Primary DNS** (string) - The primary DNS server address. - **Secondary DNS** (string) - The secondary DNS server address. - **UMTS Requested QoS** (object) - The requested Quality of Service for UMTS. - **UMTS Minimum QoS** (object) - The minimum Quality of Service for UMTS. - **GPRS Requested QoS** (object) - The requested Quality of Service for GPRS. - **GPRS Minimum QoS** (object) - The minimum Quality of Service for GPRS. - **Username** (string) - The username for authentication. - **Authentication** (integer) - The authentication type. - **IP Address** (string) - The IP address assigned to the profile. - **P-CSCF** (string) - The IP address of the P-CSCF. ``` -------------------------------- ### NAS Get AN-AAA Authentication Status Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the AN-AAA authentication status. ```APIDOC ## NAS Get AN-AAA Authentication Status Response ### Description Retrieves the AN-AAA authentication status. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Status** (string) - The AN-AAA authentication status. - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### WDS/Get Default Settings Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the default settings for a given profile type. ```APIDOC ## WDS/Get Default Settings Request ### Description This operation retrieves the default configuration settings for a specified profile type. ### Method POST ### Endpoint /WDS/GetDefaultSettings ### Parameters #### Request Body - **Profile_Type** (enum) - Required - The type of profile for which to retrieve default settings. ### Response #### Success Response (200) - **Default_Settings** (object) - Contains the default settings for the specified profile type. - **Result** (integer) - Indicates the success or failure of the operation. #### Response Example ```json { "Default_Settings": { "APN_String": "internet.default.apn" }, "Result": 0 } ``` ``` -------------------------------- ### NAS Get RF Info Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves Radio Frequency (RF) information. ```APIDOC ## NAS Get RF Info Response ### Description Retrieves Radio Frequency (RF) information. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **RF Info** (string) - Radio Frequency information. - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### WDS/Get Default Settings Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Response containing the default settings for WDS, including profile name, PDP type, APN, DNS, QoS, username, authentication, IP address, and P-CSCF. ```APIDOC ## WDS/Get Default Settings Response ### Description Response containing the default settings for WDS, including profile name, PDP type, APN, DNS, QoS, username, authentication, IP address, and P-CSCF. ### Response #### Success Response (200) - **Result Code** (integer) - The result code of the operation. - **Profile Name** (string) - The name of the default profile. - **PDP Type** (string) - The Packet Data Protocol type. - **APN Name** (string) - The Access Point Name. - **Primary DNS** (string) - The primary DNS server address. - **Secondary DNS** (string) - The secondary DNS server address. - **UMTS Requested QoS** (object) - The requested Quality of Service for UMTS. - **UMTS Minimum QoS** (object) - The minimum Quality of Service for UMTS. - **GPRS Requested QoS** (object) - The requested Quality of Service for GPRS. - **GPRS Minimum QoS** (object) - The minimum Quality of Service for GPRS. - **Username** (string) - The username for authentication. - **Authentication** (integer) - The authentication type. - **IP Address** (string) - The IP address assigned to the profile. - **P-CSCF** (string) - The IP address of the P-CSCF. ``` -------------------------------- ### WDS/Get Profile Settings Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the settings for a specified data profile. ```APIDOC ## WDS/Get Profile Settings Request ### Description This operation retrieves the configuration settings for a specific data profile. ### Method POST ### Endpoint /WDS/GetProfileSettings ### Parameters #### Request Body - **Profile_Identifier** (integer) - Required - The identifier of the profile whose settings are to be retrieved. ### Response #### Success Response (200) - **Profile_Settings** (object) - Contains the settings of the requested profile. - **Result** (integer) - Indicates the success or failure of the operation. #### Response Example ```json { "Profile_Settings": { "UMTS_Requested_QoS": {}, "Username": "user" }, "Result": 0 } ``` ``` -------------------------------- ### WDS/Create Profile Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Response from creating a profile, including the profile identifier and result code. ```APIDOC ## WDS/Create Profile Response ### Description Response from creating a profile, including the profile identifier and result code. ### Response #### Success Response (200) - **Profile Identifier** (integer) - The identifier of the created profile. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### DMS Set Firmware Preference Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Requests to set the firmware preference, including the image list, override, and index. ```APIDOC ## DMS/Set Firmware Preference Request ### Description Sets the preferred firmware for the device, specifying the image list, override status, and index. ### Request Body - **Image List** (array) - A list of available firmware images. - **Override** (boolean) - Whether to override the current firmware selection. - **Index** (integer) - The index of the preferred firmware image. ``` -------------------------------- ### DMS Get Device Manufacturer Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Provides the manufacturer of the device and the result code of the request. ```APIDOC ## DMS/Get Device Manufacturer Response ### Description Returns the manufacturer of the device and the result code of the request. ### Response #### Success Response (200) - **Manufacturer** (string) - The manufacturer of the device. - **Result Code** (integer) - The result of the operation. ``` -------------------------------- ### WDS/Get Profile List Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Response containing a list of available profiles and the result code. ```APIDOC ## WDS/Get Profile List Response ### Description Response containing a list of available profiles and the result code. ### Response #### Success Response (200) - **Profile List** (array) - A list of profile identifiers. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### WDS/Set MIP Profile Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Configures a Mobile IP profile with various parameters including addresses, agents, and security associations. ```APIDOC ## WDS/Set MIP Profile Request ### Description This operation configures a Mobile IP profile with specified parameters such as home address, home agent addresses, and security association identifiers. ### Method POST ### Endpoint /WDS/SetMIPProfile ### Parameters #### Request Body - **Index** (integer) - Required - The index of the MIP profile to set. - **State** (enum) - Optional - The state of the MIP profile. - **Home_Address** (string) - Optional - The home IP address for Mobile IP. - **Primary_Home_Agent_Address** (string) - Optional - The primary home agent IP address. - **Secondary_Home_Agent_Address** (string) - Optional - The secondary home agent IP address. - **Reverse_Tunneling** (boolean) - Optional - Enables or disables reverse tunneling. - **NAI** (string) - Optional - Network Access Identifier. - **HA_SPI** (integer) - Optional - Home Agent Security Parameter Index. - **AAA_SPI** (integer) - Optional - Authentication, Authorization, and Accounting Security Parameter Index. - **MN_HA** (integer) - Optional - Mobile Node to Home Agent security association. - **MN_AAA** (integer) - Optional - Mobile Node to AAA server security association. ### Response #### Success Response (200) - **Result** (integer) - Indicates the success or failure of the operation. #### Response Example ```json { "Result": 0 } ``` ``` -------------------------------- ### DMS Get Device Voice Number Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Provides the voice number of the device and the result code of the request. ```APIDOC ## DMS/Get Device Voice Number Response ### Description Returns the voice number associated with the device and the result code of the request. ### Response #### Success Response (200) - **Voice Number** (string) - The voice number of the device. - **Result Code** (integer) - The result of the operation. ``` -------------------------------- ### WDS/Set MIP Parameters Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Sets various parameters related to Mobile IP functionality. ```APIDOC ## WDS/Set MIP Parameters Request ### Description This operation configures various parameters for Mobile IP functionality, including security parameters, retry limits, and timeouts. ### Method POST ### Endpoint /WDS/SetMIPParameters ### Parameters #### Request Body - **SPC** (integer) - Optional - Security Parameter Code. - **Mobile_IP_Mode** (enum) - Optional - The desired Mobile IP mode. - **Retry_Attempt_Limit** (integer) - Optional - The limit for retry attempts. - **Retry_Attempt_Interval** (integer) - Optional - The interval between retry attempts. ### Response #### Success Response (200) - **Result** (integer) - Indicates the success or failure of the operation. #### Response Example ```json { "Result": 0 } ``` ``` -------------------------------- ### WDS/Get Modem Info Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves various information about the modem, including status, statistics, and connection details. ```APIDOC ## WDS/Get Modem Info Request ### Description This operation retrieves detailed information about the modem's status, connection, and data transfer statistics. ### Method POST ### Endpoint /WDS/GetModemInfo ### Parameters #### Request Body - **Requested_Status** (array) - Optional - A list of specific status indicators to retrieve. If omitted, general modem info is returned. - **Connection_Status_Indicator** (boolean) - Optional - Request connection status. - **Transfer_Statistics_Indicator** (boolean) - Optional - Request transfer statistics. - **Dormancy_Status_Indicator** (boolean) - Optional - Request dormancy status. - **Data_Bearer_Technology_Indicator** (boolean) - Optional - Request data bearer technology. - **Channel_Rate_Indicator** (boolean) - Optional - Request channel rate information. ### Response #### Success Response (200) - **Modem_Info** (object) - Contains the requested modem information. - **Result** (integer) - Indicates the success or failure of the operation. #### Response Example ```json { "Modem_Info": { "Connection_Status": "Connected", "Data_Rate_Uplink_Kbps": 10000, "Data_Rate_Downlink_Kbps": 50000 }, "Result": 0 } ``` ``` -------------------------------- ### DMS Reset Factory Defaults Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Requests to reset the device to factory default settings using an SPC. ```APIDOC ## DMS/Reset Factory Defaults Request ### Description Requests to reset the device to its factory default settings, requiring an SPC. ### Request Body - **SPC** (string) - Service Programming Code required for reset. ``` -------------------------------- ### WDS/Get Current Settings Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Retrieves the current active settings for the data connection. ```APIDOC ## WDS/Get Current Settings Request ### Description This operation retrieves the currently active settings for the data connection. ### Method POST ### Endpoint /WDS/GetCurrentSettings ### Parameters #### Request Body - **Requested_Settings** (array) - Optional - A list of specific settings to retrieve. If omitted, all current settings are returned. ### Response #### Success Response (200) - **Current_Settings** (object) - Contains the current active settings. - **Result** (integer) - Indicates the success or failure of the operation. #### Response Example ```json { "Current_Settings": { "APN_String": "internet.current.apn", "IP_Address": "192.168.1.100" }, "Result": 0 } ``` ``` -------------------------------- ### PDS Get AGPS Config Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Requests to retrieve the AGPS (Assisted GPS) configuration from the PDS. This includes network mode settings. ```APIDOC ## PDS/Get AGPS Config Request ### Description Requests to retrieve the AGPS (Assisted GPS) configuration from the PDS. This includes network mode settings. ### Method N/A (QMI Protocol) ### Endpoint N/A (QMI Protocol) ### Parameters #### Path Parameters N/A #### Query Parameters N/A #### Request Body N/A ### Request Example N/A ### Response #### Success Response (N/A) N/A #### Response Example N/A ``` -------------------------------- ### NAS System Selection Pref Indication Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Indicates changes in system selection preferences, including emergency mode, mode, band, PRL, and roaming. ```APIDOC ## NAS System Selection Pref Indication ### Description Indicates changes in system selection preferences. ### Method Not specified (likely a QMI event mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters None ### Request Example None ### Response #### Indication Data - **Emergency Mode** (string) - **Mode** (string) - **Band** (string) - **PRL** (string) - **Roaming** (string) #### Response Example None ``` -------------------------------- ### WDS/Set DNS Setting Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/GobiAPI_1.0.40/Database/QMI/Entity.txt Configures the DNS settings for WDS, including primary and secondary IPv4 and IPv6 addresses. ```APIDOC ## WDS/Set DNS Setting Request ### Description Configures the DNS settings for WDS, including primary and secondary IPv4 and IPv6 addresses. ### Parameters #### Request Body - **Primary** (string) - Optional - The primary IPv4 DNS server address. - **Secondary** (string) - Optional - The secondary IPv4 DNS server address. - **Primary IPv6 Address** (string) - Optional - The primary IPv6 DNS server address. - **Secondary IPv6 Address** (string) - Optional - The secondary IPv6 DNS server address. ``` -------------------------------- ### WDS/Get Call Record Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Call Record responses, including Record and Result Code. ```APIDOC ## WDS/Get Call Record Response ### Description Retrieves a specific call record. ### Fields - **Record** (object) - The details of the call record. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### NAS Set Network Parameters Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Sets network parameters. ```APIDOC ## NAS Set Network Parameters Response ### Description Sets network parameters. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### WDS/Get AN-AAA Authentication Status Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get AN-AAA Authentication Status responses, including Status and Result Code. ```APIDOC ## WDS/Get AN-AAA Authentication Status Response ### Description Retrieves the authentication status for AN-AAA. ### Fields - **Status** (integer) - The AN-AAA authentication status. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### DMS UIM Set Firmware ID Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Requests to set the firmware ID for the UIM card. ```APIDOC ## DMS/UIM Set Firmware ID Request ### Description Requests to set the firmware identification for the UIM card. ### Request Body - **ID** (string) - The firmware ID to set. ``` -------------------------------- ### WDS/Get Last MIP Status Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Last MIP Status responses, including Status and Result Code. ```APIDOC ## WDS/Get Last MIP Status Response ### Description Retrieves the status of the last Mobile IP (MIP) operation. ### Fields - **Status** (integer) - The status of the last MIP operation. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### DMS Activate Manual Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Requests to activate a service manually with various parameters. ```APIDOC ## DMS/Activate Manual Request ### Description Initiates a manual activation process with specified data, including PRL, MN-HA Key, MN-AAA Key, and PRL. ### Request Body - **Activation Data** (string) - Data required for manual activation. - **PRL (Obsolete)** (string) - Obsolete parameter for PRL. - **MN-HA Key** (string) - Mobile Network Home Agent Key. - **MN-AAA Key** (string) - Mobile Network Authentication, Authorization, and Accounting Key. - **PRL** (string) - Preferred Roaming List. ``` -------------------------------- ### WDS/Get Call List Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Call List responses, including Full List, ID List, and Result Code. ```APIDOC ## WDS/Get Call List Response ### Description Retrieves a list of calls associated with the data connection. ### Fields - **Result Code** (integer) - The result code of the operation. - **Full List** (list) - A list containing full details of all calls. - **ID List** (list) - A list containing only the IDs of the calls. ``` -------------------------------- ### NAS Set Technology Preference Response Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Sets the technology preference. ```APIDOC ## NAS Set Technology Preference Response ### Description Sets the technology preference. ### Method Not specified (likely a QMI request/response mechanism) ### Endpoint Not applicable (QMI interface) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response - **Result Code** (integer) - The result code of the operation. #### Response Example None ``` -------------------------------- ### DMS Set Alternate Net Config Request Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Requests to set the alternate network configuration for the device. ```APIDOC ## DMS/Set Alternate Net Config Request ### Description Requests to configure alternate network settings for the device. ### Request Body - **Config** (object) - The alternate network configuration data. ``` -------------------------------- ### WDS/Get Current Data Bearer Technology Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Current Data Bearer Technology responses, including Technology and Result Code. ```APIDOC ## WDS/Get Current Data Bearer Technology Response ### Description Retrieves the current data bearer technology being used. ### Fields - **Technology** (integer) - The current data bearer technology. - **Result Code** (integer) - The result code of the operation. ``` -------------------------------- ### WDS/Get Data Bearer Technology Response Fields Source: https://github.com/mobile-broadband/libqmi/blob/main/gobi-api/fixed-GobiAPI-1.0.40/Database/QMI/Entity.txt Details fields available in WDS Get Data Bearer Technology responses, including Technology, Last Call Technology, and Result Code. ```APIDOC ## WDS/Get Data Bearer Technology Response ### Description Retrieves information about the data bearer technology. ### Fields - **Technology** (integer) - The current data bearer technology. - **Last Call Technology** (integer) - The technology used in the last call. - **Result Code** (integer) - The result code of the operation. ```