Enumerations
This topic describes collections of enumerations used in the CorrigoPro API methods.
Actions
The following table describes all actions that are used for WebHook notifications:
| Value | Description |
|---|---|
| Accepted | A work order was accepted by a CorrigoPro user. For notification details refer Work order accepted. |
| AdditionalFieldDescriptorUpdated | A custom field configuration is updated by the requestor. |
| AppointmentInfoChanged | A work order has had it's appointment information changed. |
| AttachmentAdded | A new attachment was added by a CorrigoPro user or a customer. For notification details refer Attachment added. |
| AttachmentRemoved | An attachment was removed by a customer. For notification details refer Attachment removed. |
| CheckedIn | A work order was checked in by a CorrigoPro user. For notification details refer Technician checked in. |
| CheckedOut | A work order was completed by a CorrigoPro user. For notification details refer Technician checked out. |
| CheckListMigratedToProcedure | A work order had an active check list before procedures were released, and the check list was converted to a procedure. For notification details, refer to Check list migrated. |
| CheckListUpdated | A check list was changed by a CorrigoPro user. For notification details refer Checklist updated. (Note: See Warning Below) |
| CompletionInfoChanged | A work order's completion information has changed or adjusted after work order has been completed. For notification details refer to Completion info changed. |
| InvoiceStatusChanged | An invoice status was changed. |
| IsmStatusChanged | ISM status changed. |
| MessageSent | A new message was sent to a customer from the CorrigoPro, or a new message is received from a customer. For notification details refer Message received. |
| NeedsCompletionDetails | A work order was completed by a CorrigoPro using IVR. For notification details refer Technician checked through IVR. |
| NewWorkOrder | A new work order is submitted to he CorrigoPro. For notification details refer Work order received. |
| NteChanged | NTE was changed on a customer side, a new NTE was submitted. For notification details refer NTE changed. |
| Paused | A work order was paused by a CorrigoPro user. For notification details refer Technician paused. |
| PutOnHold | A work order was put on hold by a customer. For notification details refer Work order put on hold. |
| QuoteChanged | A quote was changed. This action can be performed by a customer or a provider. For notification details refer Quote changed. |
| Recalled | A work order was recalled by a customer. For notification details refer Work order recalled. |
| Rejected | A work order was rejected by a CorrigoPro user. For notification details refer Work order rejected. |
| Reopened | A work order was reopened. For notification details, refer to Work order reopened. |
| SLA Changed | An SLA was changed on a customer side. This action informs a provider about a new work order SLA. For notification details refer SLA changed. |
| ProcedureMarked | A Procedure has been marked as applicable or not applicable. |
| ProcedureUpdated | A customer changes a procedure in a work order accepted by your company |
| WorkVerified | A feedback was submitted by a customer. For notification details refer Work verified. |
Important
Check lists are becoming Procedures for most Enterprise clients on March 22, 2018, and we discourage their usage.
AttachmentSubtype
| Name | Description |
|---|---|
| None | No attachment type specified. |
| Signature | Attachment is a signature. |
Custom field data types.
EquipmentType
The following table describes the available types of equipment:
| Name | Description |
|---|---|
| Existing | Work done is related to some of the available equipment assets. |
| New | A new piece of equipment was installed. The installed piece of equipment is not available in a list of available assets. |
| Unknown | A repaired equipment not listed to work order. The installed piece of equipment is not available in a list of available assets. |
| Excluding | Work done is not related to a specific equipment, therefore no specific asset can be linked to a work order. |
FeedbackType
The following table describes the types of feedback:
| Value | Description |
|---|---|
| Negative | Work completion is verified. A customer is not satisfied with the quality of services provided. |
| Neutral | Work completion is verified. Quality of services provided is average. |
| Positive | Work completion is verified. Quality of services provided is beyond expectations. |
| NotCompleted | Work is not completed. |
InputErrorType
The following table describes types of model validation errors:
| Value | Description |
|---|---|
| Mandatory | Shows that a field is required but was not provided. |
| IncorrectType | Shows that a field cannot be correctly converted into expected type. |
| RangeExceeded | Indicates that a field value does not fit into allowed limits |
| DateRangeExceeded | Indicates that time span between two DateTime fields exceeds allowed limit |
| MaxLength | A value exceeds maximum length. |
| MinLength | A value is less than the minimum length. |
| InvalidPhone | A phone is invalid or has invalid format. |
| InvalidDate | A date invalid or has an invalid format. |
InvoiceStatus
| Value | Description |
|---|---|
| New | An invoice without any data - either new or after reset. Can be edited and submitted |
| Draft | An invoice that has any changes. Can be edited and submitted |
| Submitted | An invoice that has been submitted to the customer. |
| Disputed | An invoice that has been rejected by the customer. Provider is supposed to adjust/fix the invoice and re-submit. Can be edited and submitted |
| Authorized | An invoice that has been authorized by the customer. |
| Paid | An invoice that has been paid by the customer. |
| Cancelled | Indicates that a related work order was rejected/recalled. |
| WaitingForWoCompletionDetails | Indicates that a related work order was checked out without completion details. If any completion information is required by the customer, it must be provided before submitting an invoice. In other cases is similar to a New status. Can be edited and submitted |
| PendingWoComplete | Indicates that a related work order has not yet been completed. Can be edited |
| PendingVerification | Indicates that the facility manager should verify work done before invoice can be submitted. Can be edited |
LineItemCategory
| Value | Description |
|---|---|
| Labor | Category type for a labor work. Item value usually indicates fractional number of hours spent by a technician. |
| Materials | Category type for parts & materials costs. |
| Misc | Category type for miscellaneous costs. |
| Shipping | Category type for shipping costs. |
| Services | Category type for services costs. |
| PriceList | Category type for a price list item, defined by the customer. Every line item of type PriceList should be accompanied by customer item identifier. See Editing invoices for the details. |
| Tax | Category type for an item containing tax information. |
ProcedureStatus
The following table describes the types of statuses of a Procedure.
| Value | Description |
|---|---|
| Unknown | Empty/unsupported value |
| Open | Open/pending |
| NA | Marked as "not applicable" |
| Done | Done/completed |
PTE
The following table describes Permission To Enter - what a technician must do before arriving on site.
| Value | Description |
|---|---|
| Unknown | |
| Pte | |
| Appointment | |
| CallFirst | Provider must call to customer before starting a work. |
| Na |
QuoteStatus
The following table describes the quote statuses:
| Value | Description |
|---|---|
| Submitted | A provider submitted a quote for work. |
| Approved | A customer approved a quote for this work. |
| Rejected | A customer rejected a quote for this work. |
| Requested | A customer requested a quote for this work. |
SenderType
The following table describes applications that performs action:
| Value | Description |
|---|---|
| CorrigoPro | An action was initiated or message generated by a CorrigoPro application. |
| Customer | Action was initiated or message generated by a customer’s application. |
| CorrigoProDirect | A message was created by CorrigoPro Direct. |
Statuses
The following table describes work order statuses:
| Value | Description |
|---|---|
| New | A new work order is submitted by a customer. |
| Accepted | A work order is accepted by a provider. |
| Rejected | A work order is rejected by a provider. |
| Recalled | A work order is recalled by a customer. |
| CheckedIn | A work order is started by a provider. |
| Paused | A work order is paused by a provider. |
| OnHold | A work order is put on hold by a customer. |
| CheckedOut | A work order is completed by a provider. |
| Verified | A work order is verified and a feedback is submitted by a customer. |
| NeedsCompletionDetails | A work order has been completed via IVR and needs additional completion details. |
StepType
The following table describes types of steps:
| Value | Description |
|---|---|
| Unknown | Empty/unsupported value |
| Text | Simple step type which will be marked as "done" with no additional information. Closest to legacy punch list item. |
| Field | Step is linked to Custom Field; user will need to provide a value when executing step. |
| Attribute | Step is linked to Asset Attribute; user will need to provide a value when executing step; it will be copied into Asset Attribute. |
| Document | Step is informational; linked to a document; doesn't need to be marked as done. |
UpdateProcessType
The following table describes types of updates.
| Value | Description |
|---|---|
| Delete | Entity was removed. |
| Update | Entity was changed. |
| Add | Entity was added. |
ValueType
The following table describes values:
| Value | Description |
|---|---|
| Unknown | |
| String | A string literal. |
| Integer | Integer numbers should only be integer digits, without quotations, commas for thousand separators, or decimals. |
| Float | Floating-point numbers should use ‘.’ as decimal mark and without any delimiter of thousands. Example: 34823.14159265 |
| Money | |
| PhoneNumber | Phone numbers should be in international format. Value should be started with ‘+’ sign. No white spaces, dashes or other characters except digits are allowed. Example(US): +12342345555. |
| Date | DateTime values for both request and response models should be in UTC format RFC3339. Example: 2000-02-30T23:20:50.52Z |
| Time | Time values should be in format HH:mm. Example: 23:20 |
| Bool | Possible values are true and false (without quotations). |
| Url | String containing URL. |
WorkOrderType
The following table describes work order types:
| Value | Description |
|---|---|
| PMRM | Scheduled work. Preventive or routine maintenance. |
| Request | Reactive work request. |
| Visit | Scheduled work with multiple recurring visits and check-ins expected. Check-ins cannot be performed by the Direct API for work orders of the type Visit. |
VisitDay
Bitmask values used for representing scheduled days for visits.
| Value | Description |
|---|---|
| Sunday | 1 |
| Monday | 1 << 1 |
| Tuesday | 1 << 2 |
| Wednesday | 1 << 3 |
| Thursday | 1 << 4 |
| Friday | 1 << 5 |
| Saturday | 1 << 6 |
VisitStatus
| Value | Description |
|---|---|
| None | Status not verified. |
| Bad | The customer has verified a visit as bad. |
| Good | The customer has verified a visit as good. |
Updated almost 4 years ago