REST Object Definitions Configuration Related Objects Entity System Configuration Object

Entity Object Formats

JSON Format

{
  "AllowMobileCreateOrder": false,
  "CloudElements": {
    "CustomerID": "",
    "Email": "",
    "Enabled": false,
    "Modules": {
      "{ModuleID}": {
        "Enabled": true,
        "ID": "",
        "Key": "",
        "Name": "QuickBooks Online",
        "Token": ""
      }
    },
    "Name": "",
    "UserID": "",
    "UserSecret": ""
  },
  "DefaultCulturalIdentifer": "en",
  "EnableMobileApplication": true,
  "ExportNotifications": {
    "Authentication": {
      "URL": "",
      "Headers": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "Request": {
        "audience": "",
        "client_id": "",
        "client_secret": "",
        "grant_type": "client_credentials"
      },
      "Type": "OAuth2"
    },
    "Notifications": {
      "Activity": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "Audit": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "InventoryTransfer": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "InventoryUsage": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "LoadInventory": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "StockLevelRecommendation": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "TimeEntry": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      },
      "WorkOrder": {
        "Enabled": false,
        "URL": "",
        "Headers": [
          {
            "Name": "",
            "Value": ""
          }
        ]
      }
    }
  },
  "ExtUserAuth": {
    "Enabled": false,
    "AuthEndpoint": "https://sm-dev.hostedservicepower.com/mock/3rdPartyjwt"
  },
  "Invoice": {
    "EmailFrom": "sender@servicemobility.com",
    "EmailSender": {
      "SourceArn": "",
      "FromArn": "",
      "ReturnPathArn": ""
    }
  },
  "Invoicing": true,
  "JMSExpirationInDays": 30,
  "MaxLoginAttempts": 3,
  "PasswordResetLength": 10,
  "PayByLink": {
    "ID": "1002",
    "MerchantID": "CAAF8BFE-65AD-466C-A513-CC7854D4E90D",
    "UserID": "rahulmetha",
    "Passcode": ""
  },
  "Payment": {
    "GatewayID": "1001",
    "MerchantID": "CAAF8BFE-65AD-466C-A513-CC7854D4E90D",
    "UserID": "apiUser",
    "Passcode": ""
  },
  "RestApi": {
    "AuthorizationHeaders": [
      {
        "Name": "",
        "Value": ""
      }
    ],
    "AssetModels": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "URL": "https://sm-dev.hostedservicepower.com/mock/Assets/{0}/Models"
    },
    "AssetHistory": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "Criteria": "{\"and\":[{\"==\":[{\"$expression\":\"$substring(Assets[0].Model,0,6)\"},\"{{$substring(Asset.Model,0,6)}}\"]},{\"==\":[{\"$expression\":\"Assets[0].SerialNum\"},\"{{Asset.SerialNum}}\"]}]}",
      "URL": ""
    },
    "BookJob": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "URL": "https://sm-dev.hostedservicepower.com/crm/api/BookJobMock/{0}"
    },
    "EstimateHistory": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "Criteria": "{\"and\":[{\"==\":[{\"$expression\":\"$substring(Assets[0].Model,0,6)\"},\"{{$substring(Assets[0].Model,0,6)}}\"]},{\"==\":[{\"$expression\":\"Assets[0].SerialNum\"},\"{{Assets[0].SerialNum}}\"]}]}",
      "URL": "https: //sm-dev.hostedservicepower.com/mock/Account/{0}/Location/{1}/EstimateHistory"
    },
    "IVR": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "URL": "https://sm-dev.hostedservicepower.com/IVRMock/{0}"
    },
    "PartsOrdering": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "URL": "https://sm-dev.hostedservicepower.com/partsOrderingMock"
    },
    "SiteHistory": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "Criteria": "{\"in\":[{\"var\":\"Location.Address.AddrLine1\"},\"{{Location.Address.AddrLine1}}\"]}",
      "URL": ""
    },
    "SearchAppts": {
      "AuthorizationHeaders": [
        {
          "Name": "",
          "Value": ""
        }
      ],
      "URL": "https://sm-dev.hostedservicepower.com/crm/api/SearchApptsMock"
    }
  },
  "Scheduler": {
    "Host": null,
    "DBUser": null,
    "UserName": null,
    "Password": null,
    "DispatchExportTran": false,
    "IntegrationEnabled": false,
    "ExternalObjectName": null
  },
  "StockLevelRecommendation": {
    "ExpiryCheckEnabled": false,
    "ExpirationTime": 540
  },
  "SupportEmailAddress": "support@servicemobility.com",
  "SupportedCountries": "USA",
  "SSO": {
    "Enabled": false,
    "UsePKCEFlow": false
  },
  "TemplatePrefix": "",
  "TokenClaims": {
    "ExpirationTime": 5400,
    "ExpiryDeadband": 0
  },
  "WorkOrder": {
    "ClosedOverride": false,
    "GenerateHashKey": {
      "Enabled": true,
      "KeyFunctions": {
        "AccountNum": "$uppercase(\"A-\" & $string(Location.Contacts[0].LastName) & \"|\" & $string(Location.Address.Zip))",
        "LocationNum": "$uppercase(\"L-\" & $string(Location.Contacts[0].LastName) & \"|\" & $string(Location.Address.Zip))"
      }
    },
    "GenerateIncompleteOrderInvoice": true,
    "OnlyAllowProductCatalogParts": "true",
    "SendScheduleChangeNotification": false,
    "SkipDeletedWOExport": true,
    "UseSystemTaxRates": false
  }
}

Entity Object Properties

Required properties are in bold.

Property Type Description

AllowMobileCreateOrder

boolean

Identifies if the mobile worker can create a work order.

Valid values are:

true - The mobile worker can create a work order
false - The mobile worker can not create a work order

Default value is false

CloudElements

object

Contains Cloud Elements integration settings for the entity

Property Type Description

CustomerID string Identifies an unique identifier for an entity in Cloud Elements

Email string The email address of the user. This email receives all the password reset emails

Enabled

boolean

Enable use of Cloud Elements integration for mobile workers.

Valid values are:

true - Mobile workers can use Cloud Elements integration features
false - Mobile workers cannot use Cloud Elements integration features

Default value is false

Modules

object

This object contains a list of authenticated modules (elements) in Cloud Elements

Property Type Description

${ModuleID}

object

Indicates identifier for the module.

Valid values are:

1001 - Quick Books Online

Property	Type	Description
Enabled	boolean	Enable use of authenticated Cloud Elements module Valid values are: true - System can use authenticated Cloud Elements module. false - System cannot use authenticated Cloud Elements module Default value is `true`
ID	integer	Identifies unique numeric identifier for authenticated module
Key	string	Identifies alpha numeric
Name	string	Identifies name of the authenticated module
Token	string	The security token returned upon authenticating a module. You must include token in Authorization header in API calls to Cloud Elements

Name string Identifies name of an entity

UserSecret string Identifies User Secret required for API calls to Cloud Element APIs

UserID string Identifies user's unique ID for an entity registered in Cloud Elements

3.47.0

DefaultCulturalIdentifer

string

The default language code identifier associated with entity.

Default value is en

EnableMobileApplication

boolean

Enable use of mobile application for mobile workers.

Valid values are:

true - Mobile workers can use mobile application.
false - Mobile workers cannot use mobile application

Default value is true

3.37.0

ExtUserAuth

object

This object contains settings for allowing third-party authentication for mobile workers

Property Type Description

AuthEndpoint

string

Third-party Authentication service REST API endpoint

Default value is ""

Enabled

boolean

Flag to enable third-party authentication for all mobile workers within an entity

Default value is false

Invoice

object

This object contains settings which support emailing invoice to the customer

Property

Type

Description

EmailFrom

string

The FROM email address

Default value is donotreply@servicemobility.com

EmailSender

object

Identifies configuration settings for cross-account/delegate sender's identity information

Property	Type	Description
SourceArn	string	Cross-account/delegate sender's Amazon Resource Name (ARN) for email's Source
FromArn	string	Cross-account/delegate sender's Amazon Resource Name (ARN) for email's From address
ReturnPathArn	string	Cross-account/delegate sender's Amazon Resource Name (ARN) for email's ReturnPath parameter

3.33.0

Invoicing

boolean

Identifies setting for Invoicing feature. The flag value determines support for invoice generation.

Default value is true

JMSExpirationInDays

integer

Identifies ActiveMQ message's expiration value.

Default value is 30

PasswordResetLength

integer

Identifies the length of reset password

Default value is 10

PayByLink

object

This object contains configuration for sending a payment link

Property	Type	Description
ID	string	Identifies Pay by Link system ID for an entity Default value is 1002
MerchantID	string	Identifies Pay by Link system Merchant ID for an entity Default value is CAAF8BFE-65AD-466C-A513-CC7854D4E90D
UserID	string	Identifies Pay by Link system User ID for an entity Default value is rahulmetha
Passcode	string	Identifies password for Pay by Link system User ID

4.0.0

Payment

object

This object contains payment gateway information for processing payments

Property	Type	Description
GatewayID	string	Identifies payment gateway ID for an entity Default value is 1001
MerchantID	string	Identifies payment gateway Merchant ID for an entity Default value is CAAF8BFE-65AD-466C-A513-CC7854D4E90D
UserID	string	Identifies payment gateway User ID for an entity Default value is apiUser
Passcode	string	Identifies password for payment gateway User ID

RestApi

object

Identifies settings for entity hosted REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

3.35.0

AssetModels

string

Identifies settings for Asset Model Number Verification REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

URL

string

Identifies Asset Model Number Verification REST API endpoint

Default value is http://localhost:3000/mock/Assets/{0}/Models

3.33.0

AssetHistory

string

Identifies settings for Asset History REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

Criteria string Identifies criteria for matching history for an asset

URL

string

Identifies Asset History REST API endpoint

Default value is null

3.32.0

BookJob

string

Identifies settings for BookJob REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

URL

string

Identifies book job REST API endpoint

Default value is http://localhost:3000 /mock/BookJobMock/{0}

EstimateHistory

string

Identifies settings for Account Location Work Order Estimate History REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

Criteria string Identifies criteria for matching history for a work order

URL

string

Identifies Account Location Work Order Estimate History REST API endpoint

Default value is http://localhost:3000 /mock/Account/{0}/Location/{1}/EstimateHistory

3.34.0

IVR

string

Identifies settings for VR REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

URL

string

Identifies IVR REST API endpoint

Default value is http://localhost:3000 / IVRMock/{0}

PartsOrdering

string

Identifies settings for Parts Ordering REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

URL

string

Identifies parts ordering REST API endpoint

Default value is http://localhost:3000/ mock/partsOrderingMock

3.35.0

SearchAppts

string

Identifies settings for search appointment REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

URL

string

Identifies search appointment REST API endpoint

Default value is http://localhost:3000 / mock/SearchApptsMock

SiteHistory

string

Identifies settings for Site History REST API

Property Type Description

AuthorizationHeaders

collection

Identifies a collection of one or more HTTP header name and value for REST API authentication

Property Type Description

Name

string

Identifies HTTP header name for authentication.

Default value is null

Value

string

Identifies HTTP header value for authentication.

Default value is null

Criteria string Identifies criteria for matching history for a site/location

URL

string

Identifies Site History REST API endpoint

Default value is null

3.32.0

Scheduler

object

Contains ServiceScheduling integration settings for the entity

Property	Type	Description
Host	string	Scheduler instance host Default value is `null`
DBUser	string	Scheduler instance DB User (Catalog) Default value is `null`
UserName	string	Identifies user name for scheduler Default value is `null`
Password	string	Identifies password for scheduler Default value is `null`
DispatchExportTran	boolean	Flag to enable auto creation of new Export Transaction upon dispatching a new job Default value is `false`
IntegrationEnabled	boolean	Flag to enable integration with ServiceScheduling for an entity Default value is `false`
ExternalObjectName	string	External object name for scheduler technician Default value is `null`

SupportEmailAddress

string

Identifies ServiceMobility/Nexus customer care email address

Default value is support@servicemobility.com

SupportedCountries

string

Identifies comma separated list of entity supported countries.

Default value is USA

SSO

object

Contains SSO settings for the entity

Property Type Description

Enabled

boolean

Indicates the ability to use single sign-on for ServiceMobility users

Default value is false. This is the default value if this property is not specified.

UsePKCEFlow

boolean

Indicates the ability to use Authorization Flow with Proof Key for Code Exchange (PKCE)

Default value is false. This is the default value if this property is not specified.

4.2.0

TemplatePrefix

string

Identifies the prefix for Templates.

Default value is "".

3.37.0

WorkOrder

object

Identifies settings for Work Order module for the entity

Property	Type	Description
ClosedOverride	boolean	Indicates the ability to accept mobile application transactions after work order has been closed from back office Default value is `false`
OnlyAllowProductCatalogParts	boolean	Ability to only allow product catalog parts for in a work order. The valid values are "true" or "false" Default value is `true`
SendScheduleChangeNotification	boolean	Indicates the ability to send work order dispatch and schedule change notification SMS Default value is `false` 3.26.0
SkipDeletedWOExport	boolean	Identifies a flag to exclude deleted work order transactions from Work Order Export REST API Default value is `false`
UseSystemTaxRates	boolean	Indicates the ability to use system specified tax rates for totals calculation Default value is `false` 3.42.0