REST Object Definitions Configuration Related Objects 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	array	An array of JSON objects, each object containing an REST Object Definitions Account Location Related Objects Address Object associated with the Entity.
Contacts	array	An array of JSON objects, each object containing a REST Object Definitions Account Location Related Objects Contact Object associated with the Entity.
CloudStorageKey	string
CreationDateUTC	string
CustomerID	string
CustomerCode	string
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	array
IsActive	boolean	Is the Entity active or not. Default value is `true`.
IsOps	boolean	Default value is `false`.
Name	string
LanguageCodes	array
SystemID	string	UUID. Identifies publicly exposed Tenant ID.