Entities and Base Classes

Corrigo Entity

Every object in the system is represented as an Entity of a specific type.
Example: WorkOrder, Customer, Employee, etc.

Entity Specifier

The EntitySpecifier class represents a Corrigo Entity based on an identifier (Id) and the entity name (EntityType). The entity identifier is a system generated Id that is auto generated every time an entity record is created in the system and cannot be modified by the client application.
Example: For the Work Zone entity, Id = WorkZoneId and EntityType = EntityType.WorkZone.

EntitySpecifier entitySpecifier = new EntitySpecifier(Id = id, EntityType = entityType);

Commonly used Entities

Most Corrigo entities allow write access with an exceptional few that are read only.

Entity	Description	Read Only
WorkOrder	A Work Order (aka Service Request) is a solicitation for work to be performed.
WorkZone	A single fixed location or a collection of locations used to define larger geographical areas.
Customer	A local organizational unit for whom facility management service is provided.
Contact	An individual associated with a Customer and primary user of the Customer Portal.
Employee	An individual who has a specific role in the system. E.g. Techs who may perform work, FMs who may create and manage service requests, etc.
Space	A location occupied by a Customer and has optional occupancy start and end dates.
Location	Any node in the asset hierarchy.
AssetInfo	Locations of type Equipment have the AssetInfo entity.
Task	Specific action(s) performed as part of a service requests.
Priority	Defines the impact, urgency, and response timescale for service requests.	Yes
BillingAccount	An account that is used for customer invoicing and payments.	Yes
Contract	Contractual agreement bound to a Customer or Work Zone that defines billing rules for customer invoicing.	Yes
Invoice	Customer Invoice	Yes
WorkOrderCost	Service request internal costs, and vendor invoice
Payment	Payment associated with the customer invoice.	Yes

Properties

Corrigo entities have a list of associated Properties which are categorized as:

Scalar Properties are simple types that map to a single field in the storage model
Child Entities are other related Corrigo entities
Collections are arrays of related Corrigo entities

Example: A Work Order entity has the following properties representing all three categories.

Work Order Property	Type
Number	Scalar Property
TypeCategory	Scalar Property
WorkZone	Child Entity
Customer	Child Entity
Assignments	Collection
Custom Fields	Collection

Web Services Methods

Corrigo web services methods are entity-centric and an established session is required to execute the following methods.

Retrieve (Get by Id) Method

Retrieve is a parametric method and requires the identifier and entity name of the object to be retrieved.

RetrieveMultiple (Search) Method

Retrieve Multiple is used to retrieve multiple objects of an entity using specific search criteria and filters.

Execute Method

The Execute method is used to create an entity object or update specific properties of an entity object.

ExecuteMultiple Method

The Execute Multiple method is used to update properties for multiple objects of a specific entity.