REST Standard REST APIs Mobile Application Configuration REST API

It is not required to create a mobile configuration for each deployment group. If a deployment group does not have a specific mobile configuration defined it will automatically inherit form the Default deployment group.

When a mobile application configuration is updated it will automatically be applied to the mobile device the next time the application is launched or logged into - assuming network connectivity is available.

Configurations are always associated with a deployment group
There is always the Default deployment group that can not be deleted from the system.

Resource URL Summary

Get a deployment group's mobile application configuration

GET /seiapi/v3/trans/DeploymentGroup/${DeploymentGroupID}/MobileCfg

Update a deployment group's mobile application configuration

PUT /seiapi/v3/trans/DeploymentGroup/${DeploymentGroupID}/MobileCfg

API Specific Parameters

Parameter	Description
`${DeploymentGroupID}`	Identifies the Deployment Group.

Supported HTTP Methods

Method

Description

GET

Returns the mobile application configuration for the deployment group identified by the ${id} URL parameter

POST

Creates or replaces the mobile application configuration for the deployment group identified by the ${id} URL parameter.

Updates are automatically applied to the mobile device on next application launch or login - assuming network connectivity is available.

HTTP Headers
This API uses the default ServiceMobility HTTP Headers.

HTTP Body

The body contains the mobile application configuration.

JSON Format

 {
	"DXTimeout": "14500",
	"Dashboard": [
		"Info",
		"Alerts",
		"InProgress",
		"UserStatus",
		"Schedule",
		"TimeEntry",
		"Inventory",
		"ComStatus"
	],
	"DataRefreshQ": "UserDataRefreshRequest",
	"DiagnosticsUrl": "${PROTOCOL}//${HOST}:${PORT}/seiapi/v1/diagnostics",
	"Inventory": {
		"editDispositionEnabled": "true"
	},
	"NavModules": [
		"Schedule",
		"Inventory",
		"TimeEntry",
		"Social"
	],
	"SupportEmail": "",
	"SupportPhoneNumber": "000-555-1212",
	"ThirdPartyNav": [{
			"Label": "Apple Maps",
			"NavigationURI": "http://maps.apple.com/?daddr=+%daddr%,+%dcity%,+%dstate%",
			"SpaceReplace": "+"
		},
		{
			"Label": "Google Maps",
			"NavigationURI": "comgooglemaps://?daddr=+%daddr%,+%dcity%,+%dstate%&directionsmode=driving",
			"SpaceReplace": "+"
		},
		{
			"Label": "Waze",
			"NavigationURI": "waze://?q=%daddr%,%dcity%,%dstate%&navigate=yes",
			"SpaceReplace": "%20"
		},
		{
			"Label": "CoPilot Live v9",
			"NavigationURI": "copilotv9://?q=%daddr%,%dcity%,%dstate%&navigate=yes",
			"SpaceReplace": "%20"
		},
		{
			"Label": "TomTom",
			"NavigationURI": "tomtomhome://?navigateto=%daddr%,%dcity%,%dstate%",
			"SpaceReplace": "%20"
		}
	],
	"TimeEntry": {
		"timecardEnabled": "true"
	},
	"WebSocketsUrl": "${WS}//${HOST}:61614/fieldservice",
	"WorkOrder": {
		"createPartsEnabled": "true",
		"allowInvOverage": "true",
		"photosEnabled": "true",
		"pauseTravelEnabled": "true",
		"travelEnabled": "true",
		"mappingEnabled": "true",
		"lineItemsEnabled": "true",
		"assetsEnabled": "true",
		"remarksEnabled": "true",
		"signatureEnabled": "true",
		"estimatesEnabled": "true",
		"paymentsEnabled": "true",
		"showPrice": "true",
		"refundReturns": "true",
		"showLocation": "true",
		"showDescription": "true",
		"reuseOrderNumbers": "false",
		"audibleAlert": -1,
		"partOrderingUrl": "${PROTOCOL}//${HOST}:${PORT}/seiapi/v3/mobile/PartsOrdering",
		"partmapLookupUrl": "${PROTOCOL}//${HOST}:${PORT}/assets/{0}.json.txt",
		"openSlotsUrl": "${PROTOCOL}//${HOST}:${PORT}/seiapi/v3/trans/Appointments/OpenSlots",
		"followupApptUrl": "${PROTOCOL}//${HOST}:${PORT}/seiapi/v3/trans/WorkOrder/{0}/Followup",
		"defaultCloseCodes": {
			"Status": "4097",
			"Reason": "1001"
		}
	},
	"allowTimeEntryOverlap": "false",
	"autoPoll": "-10",
	"cachedPasswordTimeout": "240",
	"dataUpdateNotificationsEnabled": "false",
	"gpsPollingInternval": 60000,
	"guidCache": {
		"requestThreshold": "900"
	},
	"imageBaseUrl": "https://s3.amazonaws.com/SPMobility/",
	"imageKeyUrl": "{module_id}/{entity_pkey}/{biz_key}/{image_name}",
	"largeMsgSize": "50000",
	"largeFormFactorEnabled": false,
	"logLevel": "4",
	"mapKey": "AIzaSyAYFRZcoDkX6UMol7NIvFIU5HADgblYU-M",
	"msgMaxRetryCount": "3",
	"msgRetryTimeout": "5000",
	"partRequestQty": 10,
	"partRequestUrl": "${PROTOCOL}//${HOST}:${PORT}/seiapi/v3/query/Products?q={0}::in:ProdNum,Desc&filter=IsOffLine:0&start={1}&limit={2}&sort=ProdNum",
	"partsLocatorUrl": "${PROTOCOL}//${HOST}:${PORT}/seiapi/v3/PartsLocator",
	"paymentUrl": "${PROTOCOL}//${HOST}:${PORT}/seiapi/v3/mobile/Payment/Charge?format=json",
	"photoCacheSize": "5",
	"pingInternvalInSeconds": 300,
	"productSearchThreshold": 250,
	"purgeValues": {
		"workOrder": "7",
		"inventory": "7",
		"timeEntry": "30",
		"logEntries": "14"
	},
	"useIndexedDB": false,
	"userStatusEnabled": true,
	"weekStartDay": "Monday"
}

HTTP Response

Response Codes

HTTP Code	Description
200	OK. Request was processed successfully. Even though the request may return a successful code of 200, the body may still contain warning details.
400	Syntax error in request. The response body will provide more details on the specific reason. Verify the URI, its parameters, and request body.
401	Unauthorized. The credentials are incorrect, please verify and try again.
404	Not Found. The URL is incorrect, please verify and try again.
405	The specified HTTP method is not supported for this resource.
409	Conflict. This error usually occurs when attempting to overwrite an existing object that can not be replaced.
410	The specified object does not exists. Please verify the URI.
500	An error has occurred within ServiceMobility. Please review the error message details and if necessary, contact customer support.

Response Body

{
    "code": 400,
    "detail": {
        "message": "",
        "params": {
            "value": ""
        },
        "dataPath": ""
    }
}

Response Object Properties

Property

Type

Description

code

integer

The HTTP response code.

detail

object

This object provides additional details the system provided while processing the transactions. Usually the details provide additional information on why an error occurred. However, it may also provide warning details even when the requests was successful. For example, the request may have returned a response of 200=OK, but included warnings in the response body of properties that are still being used that are marked for deprecation.

Property	Type	Description
message	string	A human readable message related to the processing of the request.
params	collection	A collection of additional key/value pairs that contain the values that caused the warning/error condition.
dataPath	string	Identifies the location within the request body the message refers to.