{"_id":"59516ae6fafb63003375d556","category":{"_id":"59516ae6fafb63003375d54f","version":"59516ae6fafb63003375d54e","project":"5425e663ffd4411c319a65b4","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-09-26T23:22:58.179Z","from_sync":false,"order":0,"slug":"getting-started","title":"Getting Started"},"project":"5425e663ffd4411c319a65b4","user":"5425e31affd4411c319a65b1","version":{"_id":"59516ae6fafb63003375d54e","project":"5425e663ffd4411c319a65b4","__v":1,"createdAt":"2017-06-26T20:13:26.122Z","releaseDate":"2017-06-26T20:13:26.122Z","categories":["59516ae6fafb63003375d54f","59516ae6fafb63003375d550"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.4.0","version":"2.4"},"__v":0,"updates":["5866202b63cc142300cfa621","586620472829782300351f66","5866207ca818d02300735cc3"],"next":{"pages":[],"description":""},"createdAt":"2014-09-29T20:07:47.694Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"never","params":[],"url":""},"isReference":false,"order":5,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Organization\"\n}\n[/block]\nOrganizations represent the top-most entity on Onfleet. Administrators, teams, workers and tasks all belong to an organization. Further, organizations may be linked to other organizations so that tasks can be assigned across organizational boundaries through the [Connections](http://support.onfleet.com/hc/en-us/sections/200922245-Connections) feature.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Administrator\"\n}\n[/block]\nAdministrators are users who perform actions via the dashboard. An organization has one administrator of type ```super``` and zero or more of type ```standard``` (also known as *dispatchers* in the dashboard).  Administrators manage workers based on membership in the organization’s teams.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Worker\"\n}\n[/block]\nWorkers (also known as *drivers* in the dashboard) are the members of an organization who perform actions via the Onfleet mobile applications. They may belong to teams managed by any number of administrators in their own organization. Workers have a vehicle with which tasks are completed.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Hub\"\n}\n[/block]\nA hub is a depot for a team: the location from where all deliveries start for the team's workers, for the purposes of route optimization only; teams can have zero or one hubs.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Team\"\n}\n[/block]\nTeams are named entities that bring together administrators and workers belonging to the same organization. Teams have hubs from where its workers may start and end their shifts.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Destination\"\n}\n[/block]\nDestinations represent the location details for tasks, including exact coordinate and address information.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Recipient\"\n}\n[/block]\nA recipient is an organization’s customer and a target for a task, that is, whom the task is being delivered to.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Task\"\n}\n[/block]\nTasks represent units of work, defined by one destination and one recipient, that administrators create and assign to workers for completion.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Container\"\n}\n[/block]\nContainers are an abstraction which describes task assignment. \n\nA container is an ordered list of tasks. Tasks always belong to exactly one container -- once created and when reassigned. When a task is started by a worker, it is no longer part of that container's tasks. \n\nOrganizations, teams and workers all correspond to containers as they can all be assigned tasks.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Webhook\"\n}\n[/block]\nWebhooks make it possible for your application to be notified of important system events, as soon as these take place within Onfleet.","excerpt":"Here's a summary of the various entities that you can interact with.","slug":"entities","type":"basic","title":"Entities"}

Entities

Here's a summary of the various entities that you can interact with.

[block:api-header] { "type": "basic", "title": "Organization" } [/block] Organizations represent the top-most entity on Onfleet. Administrators, teams, workers and tasks all belong to an organization. Further, organizations may be linked to other organizations so that tasks can be assigned across organizational boundaries through the [Connections](http://support.onfleet.com/hc/en-us/sections/200922245-Connections) feature. [block:api-header] { "type": "basic", "title": "Administrator" } [/block] Administrators are users who perform actions via the dashboard. An organization has one administrator of type ```super``` and zero or more of type ```standard``` (also known as *dispatchers* in the dashboard). Administrators manage workers based on membership in the organization’s teams. [block:api-header] { "type": "basic", "title": "Worker" } [/block] Workers (also known as *drivers* in the dashboard) are the members of an organization who perform actions via the Onfleet mobile applications. They may belong to teams managed by any number of administrators in their own organization. Workers have a vehicle with which tasks are completed. [block:api-header] { "type": "basic", "title": "Hub" } [/block] A hub is a depot for a team: the location from where all deliveries start for the team's workers, for the purposes of route optimization only; teams can have zero or one hubs. [block:api-header] { "type": "basic", "title": "Team" } [/block] Teams are named entities that bring together administrators and workers belonging to the same organization. Teams have hubs from where its workers may start and end their shifts. [block:api-header] { "type": "basic", "title": "Destination" } [/block] Destinations represent the location details for tasks, including exact coordinate and address information. [block:api-header] { "type": "basic", "title": "Recipient" } [/block] A recipient is an organization’s customer and a target for a task, that is, whom the task is being delivered to. [block:api-header] { "type": "basic", "title": "Task" } [/block] Tasks represent units of work, defined by one destination and one recipient, that administrators create and assign to workers for completion. [block:api-header] { "type": "basic", "title": "Container" } [/block] Containers are an abstraction which describes task assignment. A container is an ordered list of tasks. Tasks always belong to exactly one container -- once created and when reassigned. When a task is started by a worker, it is no longer part of that container's tasks. Organizations, teams and workers all correspond to containers as they can all be assigned tasks. [block:api-header] { "type": "basic", "title": "Webhook" } [/block] Webhooks make it possible for your application to be notified of important system events, as soon as these take place within Onfleet.