Windows URI Scheme

TMM registers a custom URI scheme, trimblemobilemanager, with the Windows operating system, which allows other applications to:

• Launch TMM.
• Show TMM UI.
• Use TMM workflows, and get workflow results.
• Query information from TMM.

Callback URI - Getting a response from TMM

Some TMM requests pass a response back to your application, using your application’s custom URI scheme.

1. Configure your application to Handle URI activation.
2. For any TMM request that requires a callback, pass a URI that uses your custom URI scheme. Example:

   trimblemobilemanager://{request}?callback=my-custom-scheme%3A%2F%2Fhandle-tmm-response

3. TMM will then format the response to your request using callback. Example:

   my-custom-scheme://handle-tmm-response?param1=value%201&param2=value%202

Windows Requests

tmmCorrectionSettings — Open the Configuration page.

Remarks

Navigates TMM to the configuration page to edit the correction settings.

Inputs

Request URI

trimblemobilemanager://request/tmmCorrectionSettings?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmCorrectionSettings&status={status}&message={message}

• id (String): tmmCorrectionSettings
• status (String): “success” or “error”
• message (String): Additionall information

tmmOnDemand — Open to the On Demand page

Remarks

Opens TMM to the receiver selection popup.

Inputs

Request URI

trimblemobilemanager://request/tmmOnDemand?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmOnDemand&status={status}&message={message}&currentClaim={currentClaim}&claimCountdown={claimCountdown}

• id (String): tmmOnDemand
• status (String): “success” or “error”
• message (String): Additionall information
• currentClaim (String): The current claim in the process.
• claimCountdown (String): The countdown for the claim.

tmmOpenLaserOffset — Open the Laser Offset Routine.

Remarks

Opens the Laser Offset data collection workflow in TMM.

Inputs

Request URI

trimblemobilemanager://request/tmmOpenLaserOffset?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

On success: {callback}?id=tmmOpenLaserOffset&status={status}&message={message}&referenceContext={referenceContext}&geometry={geometry}&useLocationProfile={useLocationProfile}&useAntennaHeight={useAntennaHeight}&featureAttributes={featureAttributes}
On error: {callback}?id=tmmOpenLaserOffset&status={status}&message={message}

• id (String): tmmOpenLaserOffset
• status (String): “success” or “error”
• message (String): Additional information
• referenceContext (String): Context for the returned point; on success “addVertex”.
• geometry (String): Comma-separated "{latitude},{longitude}" or "{latitude},{longitude},{elevation}" (elevation omitted if not available).
• useLocationProfile (String): On success “true”.
• useAntennaHeight (String): On success “false”.
• featureAttributes (String): URL encoded JSON object. Compatible with ESRI GNSS / offset metadata fields.

tmmOpenToAntennaHeight — Open the Antenna Height page.

Remarks

Navigates TMM to the Antenna Height page.

Inputs

Request URI

trimblemobilemanager://request/tmmOpenToAntennaHeight?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmOpenToAntennaHeight&status={status}&message={message}

• id (String): tmmOpenToAntennaHeight
• status (String): “success” or “error”
• message (String): Additionall information

tmmOpenToConfiguration — Open the Configuration page.

Remarks

Navigates TMM to the Configuration page.

Inputs

Request URI

trimblemobilemanager://request/tmmOpenToConfiguration?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmOpenToConfiguration&status={status}&message={message}

• id (String): tmmOpenToConfiguration
• status (String): “success” or “error”
• message (String): Additionall information

tmmOpenToLoginPage — Open the login page

Remarks

It initiates the process of navigating to the login page in the TMM application.

Inputs

Request URI

trimblemobilemanager://request/tmmOpenToLoginPage?applicationId={applicationId}&callback={callback}

• applicationId (string): The client application ID.
• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmOpenToLoginPage&status={status}&message={message}&userTID={userTID}&tpsdkVersion={tpsdkVersion}

• id (String): tmmOpenToLoginPage
• status (String): “success” or “error”
• message (String): Additionall information
• userTID (String): The user’s TID.
• tpsdkVersion (String): The TPSDK version.

tmmOpenToReceiverSelection — Open the receiver selection page

Remarks

Opens TMM to the receiver selection popup.

Inputs

Request URI

trimblemobilemanager://request/tmmOpenToReceiverSelection?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmOpenToReceiverSelection&status={status}&message={message}

• id (String): tmmOpenToReceiverSelection
• status (String): “success” or “error”
• message (String): Additionall information

tmmOpenToSkyplot — Open the Skyplot page.

Remarks

Navigates TMM to the Skyplot page.

Inputs

Request URI

trimblemobilemanager://request/tmmOpenToSkyplot?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmOpenToSkyplot&status={status}&message={message}

• id (String): tmmOpenToSkyplot
• status (String): “success” or “error”
• message (String): Additionall information

tmmRegister — Register client application

Remarks

Retrieves the port information for the API server, LocalHost server, and LocalHost server V2. The port information includes the API port, location port, location secure port, and location V2 port.

Inputs

Request URI

trimblemobilemanager://request/tmmRegister?applicationId={applicationId}&callback={callback}

• applicationId (string): The client application ID
• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmRegister&status={status}&message={message}&registrationResult={registrationResult}&apiPort={apiPort}&apiSecurePort={apiSecurePort}&locationPort={locationPort}&locationSecurePort={locationSecurePort}&locationV2Port={locationV2Port}&locationV2SecurePort={locationV2SecurePort}

• id (String): tmmRegister
• status (String): “success” or “error”
• message (String): Additionall information
• registrationResult (String): Indicates the result of the registration check. This can be “OK”, “NoNetwork”, or “Unauthorized”
• apiPort (Int): The insecure port number for the REST API.
• apiSecurePort (Int): The secure port number for the REST API.
• locationPort (Int): The insecure port for the V1 WebSocket
• locationSecurePort (Int): The secure port for the V1 WebSocket
• locationV2Port (Int): The insecure port for the V2 WebSocket
• locationV2SecurePort (Int): The secure port for the V2 WebSocket

tmmSocketServerPort — Query the list of TMM server ports

Remarks

It retrieves the port information for the API server, LocalHost server, and LocalHost server V2. The port information includes the API port, location port, location secure port, and location V2 port.

Inputs

Request URI

trimblemobilemanager://request/tmmSocketServerPort?callback={callback}

• callback (string): The callback URI TMM will launch in response to the the operation’s completion

Outputs

Response URI

{callback}?id=tmmSocketServerPort&status={status}&message={message}&apiPort={apiPort}&apiSecurePort={apiSecurePort}&locationPort={locationPort}&locationSecurePort={locationSecurePort}&locationV2Port={locationV2Port}&locationV2SecurePort={locationV2SecurePort}

• id (String): tmmSocketServerPort
• status (String): “success” or “error”
• message (String): Additionall information
• apiPort (Int): The insecure port number for the REST API.
• apiSecurePort (Int): The secure port number for the REST API.
• locationPort (Int): The insecure port for the V1 WebSocket
• locationSecurePort (Int): The secure port for the V1 WebSocket
• locationV2Port (Int): The insecure port for the V2 WebSocket
• locationV2SecurePort (Int): The secure port for the V2 WebSocket