Entity Object

Entity Object Formats

JSON Format

{
    "Addresses": [{
        "AddrLine1": "",
        "AddrLine2": "",
        "AddrLine3": "",
        "AddrLine4": "",
        "AddrType": "",
        "City": "",
        "Country": "",
        "Intersection": "",
        "Lat": "",
        "Lon": "",
        "Region": "",
        "Zip": ""
    }],
    "Contacts": [{
        "Email": "",
        "FirstName": "",
        "IsPrimary": true,
        "LastName": "",
        "Phones": [{
            "PhoneNum": "",
            "PhoneType": ""
        }]
    }],
    "CloudStorageKey": "",
    "CreationDateUTC": "",
    "CustomerID": "",
    "CustomerCode": "",
    "Domain": "",
    "EntityID": "",
    "features": [],
    "IsActive": true,
    "IsOps": false,
    "Name": "",
    "LanguageCodes": [],
    "SystemID": ""
}

Entity Object Properties

Required properties are in bold.

Property	Type	Description
Address	collection	Collection of zero or more JSON objects, each object containing an Account Location Related Objects Address Object associated with the Entity.
Contacts	collection	Collection of one or more JSON objects, each object containing a Account Location Related Objects Contact Object associated with the Entity.
CloudStorageKey	string	UUID. Identifies a unique storage key for storing tenant specific artifacts in AWS S3 bucket.
CreationDateUTC	string	The date and time, in UTC format, the tenant was originally created.
CustomerID	string	Contains customer identifier for the tenant. CustomerID and CustomerCode values are passed as URI parameters for REST API authentication. The preferred way of authentication is to use JWT token in HTTP header.
CustomerCode	string	Contains customer code (password) for the tenant.
Domain	string	An optional custom domain (which must be a sub-domain of servicemobility.com) for the tenant, representing the domain on which the tenant will be accessed. For example: "custom.servicemobility.com"
EntityID	string	The unique ID of the Entity.
features	collection	A collection of one or more features which tenant has access to in ServiceMobility. Valid feature values are: SH
IsActive	boolean	Is the Entity active or not. Default value is `true`.
IsOps	boolean	Default value is `false`.
Name	string	Identifies the name of the tenant
LanguageCodes	collection	Default value is `en`. A collection of one or more cultural identifiers associated with tenant. Valid cultural identifier values are: en en-CA en-GB fr-CA
SystemID	string	UUID. Identifies publicly exposed Tenant ID.