Attributes are the specifications that determine the actions or tasks a Property or a Facility can perform. The Facility APIs provide a standard set of system-defined Attributes for a 

The following list describes the predefined Property Attributes that are unique to defining a physical location:

The following list describes the predefined Facility Attributes that are unique to defining an operating entity:

Discover a comprehensive list of predefined attributes for property and facility entities in this document. From property names and codes to location details and geolocation, explore a wealth of information for properties. Additionally, find essential det

How to: Update a Facility

Property and Facility Attributes

clientID

Creating Property and Facility

Platform

What is OS1?

Who can benefit from OS1?

Why use OS1?

OS1 Architecture

OS1 Overview

Create an Account

Make your First API Call

Obtain your Credentials

Quick Start

Working with Callbacks

Asynchronous APIs

Custom Code

Working with GraphQL

Custom Attributes Ownership

Attribute-Based Access Control (ABAC)

Concepts

Authentication And Authorization

How to use Entities?

Entity

Integrate with Participants

Participant

Integrate with Containers

Container

User API

How To: Create a User

How to: Change State of a User

How to: Retrieve State of a User

How to: Retrieve a Designation

How to: Find the User ID of a User

How to: Update a User

User Management Service

Teams Management Service

Integrate with Platform Order Management

Platform Order Attributes and Lifecycle

Work Order Attributes and Lifecycle

Order Validation and Enrichment Plugins

Order Service

Jobs and Objectives

Integrate with Dispatch

Dispatch Service

Integrate with Orchestrator

Job Manager Plugin

Container Manager Plugin

Work Order Manager Plugin

Workflow Manager Plugin

Cancellation Manager Plugin

Orchestrator Service

Execution Task and Macro Payloads

Workflow Service

Getting Started

Location Tracking

MTS Subscription

MTS Snapped Distance

MTS Geofences

MTS Tiles

MTS ETA

Speed Profiling

MTS Nearby Search

MTS API Migration Guide

Movement Tracking System

Country Data

Location Service

Use Cases and Features

Messaging

Mobile Push Notifications

Messaging and Mobile Push Notifications

Secure Data Storage

File Management Service

Scheduler Service

Search Query Format

Data Listing and Query (DLQS) Search

Publishing Webhook Events

Subscribing to Webhook Events

Egress Events for Publishers

Webhooks

State Machine

What Services OS1 Offer?

Get Started with Apps and Solutions

OS1 App Developer’s Guide

Registering Your App

Update App Attributes

Add Solutions Compatibility

Submit for Review

App Version Management

Get App Details

Retrieving Production Credentials

Untitled

OS1 Solution Developer Guide

Register Your Solution

Update Solution

Submit Solution for Review

Solution Version Management

Get Solution Details

Solns

Console Banner

Common APIs Overview

Onboarding Apps and Solutions

Managing App and Solution Artifacts

Troubleshooting

Common

SDK Overview

MTS SDK

Dispatch SDK

AAA SDK

Workflow Designer SDK

Console SDK

Platform SDKs

Vehicle Management App

Container App

Sample Apps

SDKs & Sample Apps

Glossary

FAQs

Reason Codes

Error Codes

Data Types Used in OS1

App Development Guidelines

Soln Development Guidlines

Development Guidelines

Console UI Overview

Additional Resources

DispatchOne Overview

Integrate with Logistics Order

Predefined Logistics Order API Attributes

LogisticsOrder API Functionalities

LogisticsOrder API

Integrate with Facilities

Property and Facility Lifecycle

Facility API

Integrate with Vehicles

Vehicle Attributes

Vehicle Lifecycle

Vehicle API

DispatchOne Solution

Attribute	Data type	Descriptions
propertyName	string	Name of the participant Property. Character length: 1-64.
propertyCode	string	Any unique associated with the participant Property being created. Character length 1-64.
propertyOwnerId	string	The participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64.
area	number	Area of the Property.
propertyOwnership	string	Value: self, rented, partner, client
location	VarChar	Physical mapping of the area to mark the property.
location> houseNumber	string	Building number in which the apartment is.
location> addressLine1	string	Address line 1.
location> addressLine2 (optional)	string	Optional address line 2.
location> addressLine3 (optional)	string	Optional address line 3.
city	string	City of the Property.
state	string	State of the Property.
zipCode	string	Zip code of the Property.
country	object	Country of the Property. Value: Code example - IN, Name example - India
geolocation	string	Location of property marked by its latitude & longitude.
geolocation> latitude	string	Latitude of the Property.
geolocation> longitude	string	Longitude of the Property.

Attribute	Data type	Description
facilityName	string	Name of the participant Facility. Character length: 1-64.
facilityCode	string	Any unique ID associated with the participant Facility being created. Character length: 1-64.
facilityOwnerId (optional)	string	The participant ID of the participant type as specified in allowedOwners during the creation of the said type. Character length: 1-64.
facilityType	string	Type of Facility.
propertyId	string	ID if the Property to which this Facility belongs. Or you can provide property details including: propertyname, propertycode, propertyownerID, area, propertyownership, location.
area	number	Area of the Facility.
operatingduration	string	Hours of operation of the Facility. (hh:mm:ss to hh:mm:ss)
operatingDays (optional)	array	Days of operation of the Facility. (days of the week/dates in a month)
startTime	string	Starting time of the facility.
endTime (optional)	string	End time of the facility.
teams (optional)	array	The array of team IDs the facility belongs to.