Learn more ways to transact with Corrigo Enterprise beyond POST/PUT/DELETE
This endpoint provides a mechanism to create more advanced Entities and specialized workflow logic. Especially when working with integrated workflows the command endpoint is a important tool for implementing business logic across integrated applications.
POST {Host Name}/api/v1/cmd/{Command Class Name}
where {Host Name} is derived from GetCompanyWsdkUrlCommand.Url, and
{Command Class Name} is any Class in the Commands Namespace, and
{Request body} contains valid JSON data per the Class properties.
JSON content for each Command is listed below.
GetCompanyWsdkUrlCommand
API consumers shall use this command to detect changes to the Host name component of the endpoint URL. Implementations vary, but most commonly this Command is executed when an expired Bearer token is refreshed (see Authorization), so that both the Bearer token and Host name are resolved in unison.
How to access a Sandbox Company
Direct licensees of Corrigo Enterprise have one or more non-Live Companies referred to as Stage or Preview instances. Any non-Live Company can be used as a Sandbox, once configured by the Corrigo System Administrator. The System Administrator can provide API credentials to any authorized internal or external development teams.
For Technology Partners seeking to develop reusable solutions, a temporary Sandbox can be provided pursuant to enrollment in the JLLT Integration Marketplace, which is planned for launch in April 2022.
The Response tab contains CommandResult example which includes URL element to be used as the Host name for subsequent operations.
| Discovery by Regions |
|---|
| Americas (includes USA and Canada): Discovery URL for GetCompanyWsdkUrlCommand: http://am-apilocator.corrigo.com/api/v1/cmd/GetCompanyWsdkUrlCommand |
| Asia Pacific (APAC): Discovery URL for GetCompanyWsdkUrlCommand: http://apac-apilocator.corrigo.com/api/v1/cmd/GetCompanyWsdkUrlCommand |
| Europe, Middle-east and Africa (EMEA): Discovery URL for GetCompanyWsdkUrlCommand: http://emea-apilocator.corrigo.com/api/v1/cmd/GetCompanyWsdkUrlCommand |
POST /api/v1/cmd/GetCompanyWsdkUrlCommand HTTP/1.1
Host: am-apilocator.corrigo.com
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMi4yNDYuZjkxYyIsIlZhbHVlVHlwZSI6Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hI3N0cmluZyIsIklzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSIsIk9yaWdpbmFsSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIn0seyJUeXBlIjoidXJuOm9hdXRoOnNjb3BlIiwiVmFsdWUiOiIiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6IkF1ZCIsIlZhbHVlIjoiMjQ2IiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifV0sIlByb3BlcnRpZXMiOnsiRGljdGlvbmFyeSI6eyIuaXNzdWVkIjoiVHVlLCAwOCBGZWIgMjAyMiAwMzo0NzoyMCBHTVQiLCIuZXhwaXJlcyI6IlR1ZSwgMDggRmViIDIwMjIgMDQ6MDc6MjAgR01UIn19fQ<---->AQHglEo4Oyyi6Jl7_jFNBJw4YeyaZHWVogvqRCvOUZYGEWSsAqV2-9xrrPO658AOuVDRRhUKGa4asI_GzX77oWHCi9WGIPYcfKBYXPqpQPr19EF4q7Dpj2JaCc36chBaf5iynZrlRSOcO82Uge69R0YoY4d6xZbGyYi5OpvTD2I9vdmuT_lyh1l67HKnDaFqWvReIlVWw5hNPU24emAHKdkVdKw43_PwGmt3G5z72gkCOV95ibDyeRVIMzB_TURzvFKNcp1geVaDcNa73HHDH0V-syCA2j2Pwzqa-wUjtYjVRsQumIUw79LDdDVUcgvgUI_yfgujsZmMYLrAdGi12Q
Content-Length: 125
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Command" : {
"ApiType" : "REST",
"CompanyName" : <<Sample Company>>,
"Protocol" : "HTTPS"
}
{
"CommandResult" : {
"Url" : "<<AM Host Name>>/",
"CompanyName" : "<<Sample Company>>",
"Protocol" : "HTTPS",
"CompanyVersion" : "<<Build Number>>",
"CompanyId" : 246
}
}
WoCreateCommand
As the core entity of the entire application, the WorkOrder entity contains numerous dependencies on other entities, which in turn necessitates retrieval of Entity Id values for those references. Be certain to visit the GET (Retrieve) and QueryExpression sections before attempting WoCreateCommand.
The Response tab contains CommandResult example which in turn contains a JSON representation of the Entity that was just created, including any auto-calculated values such as WorkOrder.Number.
POST <<AM Host Name>>/api/v1/cmd/WoCreateCommand HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMi4yNDYuZjkxYyIsIlZhbHVlVHlwZSI6Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hI3N0cmluZyIsIklzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSIsIk9yaWdpbmFsSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIn0seyJUeXBlIjoidXJuOm9hdXRoOnNjb3BlIiwiVmFsdWUiOiIiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6IkF1ZCIsIlZhbHVlIjoiMjQ2IiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifV0sIlByb3BlcnRpZXMiOnsiRGljdGlvbmFyeSI6eyIuaXNzdWVkIjoiTW9uLCAwNyBGZWIgMjAyMiAyMjozNTozMSBHTVQiLCIuZXhwaXJlcyI6Ik1vbiwgMDcgRmViIDIwMjIgMjI6NTU6MzEgR01UIn19fQ<---->PVtZBKow5OQuVbRYwyhiTAGFKmaRvEw0lVeq7apW4vdS0uXdC1fOb2aPz12QwODEev8H_Pi6wRnXz0aH7ysadiyZKJqQSgzknb-kphpTNvbvJBHbw5TaydRN4-3N--M5_QERguFrJjwWTc2AkCxVf78QYcLZrXCeGuExAQ6gO2VtBmlxC-ZDG6d1Bv33DVR4F9LHfi6bKKqfAlR8VknNqIAgnYJnkWBNipACsQejc4vD4DE7WOYGdmiWI0xLy1CBnQh9K_lEpP0kuO8v5atDRWJoe9ymDzT9b5_Cd7DXYqbQO1Zt7YnH7o_oxO3zeBxCyUJ3KFSclaqghK6TDDntWA
Content-Length: 860
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Command" : {
"WorkOrder" : {
"Items" : [
{
"Asset" : {
"Id" : 12584
},
"Task" : {
"Id" : 14389
}
}
],
"Contactid":2,
"TypeCategory" : 4,
"SubType" : {
"Id" : 259
},
"Customer" : {
"Id" : 3
}
},
"ComputeSchedule" : true
},
"RequestId" : "0242422.3341"
}
{
"CommandResult" : {
"Wo" : {
"Number" : "AP00002000009",
"TypeCategory" : "Request",
"WorkOrderCost" : {
"Id" : 154095,
"CurrencyTypeId" : "Unknown",
"BillToType" : "None",
"CostsTotal" : {
"CurrencyTypeId" : "Unknown",
"Value" : 0.0
},
"ApStateId" : "None",
"ApStatusId" : 1,
"JobCode" : "",
"AuthorizationCode" : "",
"CheckNumber" : "",
"PaymentAmount" : {
"CurrencyTypeId" : "Unknown",
"Value" : 0.0
},
"PaymentNotes" : "",
"GlAccount" : "",
"Number" : "",
"VendorInvoiceTotal" : {
"CurrencyTypeId" : "Unknown",
"Value" : 0.0
},
"IsPreBilled" : false,
"ExpensesTotal" : {
"CurrencyTypeId" : "Unknown",
"Value" : 0.0
},
"BillingRule" : "Unknown",
"TaxStatus" : "Unknown",
"CustomerNte" : {
"CurrencyTypeId" : "Unknown",
"Value" : 0.0
},
"Items" : [ ],
"ServiceFeesTotal" : {
"CurrencyTypeId" : "Unknown",
"Value" : 0.0
},
"CostStatusId" : 1,
"CostState" : "Pending",
"ExternalId" : "",
"ConcurrencyId" : 1,
"PerformDeletion" : false,
"IsNew" : false
},
"Priority" : {
"IsEmergency" : false,
"AcknowledgeInMinutes" : 0,
"RespondInMinutes" : 0,
"DueInMinutes" : 0,
"Id" : 3,
"PerformDeletion" : false,
"IsNew" : false
},
"StatusId" : "New",
"RequestorContact" : {
"DisplayAs" : "",
"FirstName" : "",
"LastName" : "",
"TypeId" : "Unknown",
"CustomerId" : 0,
"CanViewAnyRequest" : false,
"CanCreateRequest" : false,
"PriorityThreshold" : 0,
"CustomFields" : [ ],
"ContactAddresses" : [ ],
"GroupsBridge" : [ ],
"MustResetPassword" : false,
"NoAlertEmails" : false,
"UnlimitedRequest" : false,
"UnlimitedAuthorization" : false,
"SupervisorId" : 0,
"LanguageId" : 0,
"CustomerNoteAccessId" : "Unknown",
"NoPwdExpirationAlert" : false,
"Currencies" : [ ],
"IsRemoved" : false,
"ConcurrencyId" : 0,
"Id" : 3,
"PerformDeletion" : false,
"IsNew" : false
},
"Access" : "NotApplicable",
"MainAsset" : {
"Name" : "",
"ModelId" : 0,
"Orphan" : false,
"TypeId" : "Unknown",
"ParentId" : 0,
"RootId" : 0,
"IsTemplate" : false,
"Documents" : [ ],
"IsOffline" : false,
"IsLocked" : false,
"Attributes" : [ ],
"Id" : 40133,
"PerformDeletion" : false,
"IsNew" : false
},
"ShortLocation" : "Carpark",
"TaskRefinement" : "Electrical:Breaker",
"WorkZone" : {
"DisplayAs" : "",
"TimeZone" : 0,
"LanguageId" : 0,
"WoNumberPrefix" : "",
"Entity" : "",
"SchedulingWindow" : 0,
"NoIncompleteProcedure" : false,
"AccessOptionsMask" : 0,
"Number" : "",
"AdvanceNotice" : 0,
"WoNumberDigits" : 0,
"RoundApptTimeTo" : 0,
"WorkPlanAutoCancel" : false,
"WorkPlanChildResolution" : false,
"WorkPlanAutoDependency" : false,
"CpThemeId" : 0,
"DefaultAccess" : "Unknown",
"AutoAssignEnabled" : false,
"BackupRoutingId" : "Unassigned",
"NoIncompleteItem" : false,
"UiShowProvidersFirst" : false,
"CurrencyTypeId" : "Unknown",
"IsOffline" : false,
"ContactAddresses" : [ ],
"CustomFields" : [ ],
"Portfolios" : [ ],
"SlaValues" : [ ],
"Teams" : [ ],
"BizHours" : [ ],
"EscalationRules" : [ ],
"SpecDispatchRules" : [ ],
"OnCallRules" : [ ],
"Responsibilities" : [ ],
"UseBizHours" : false,
"UseHolidays" : false,
"UseOnCall" : false,
"UseEscalation" : false,
"DefaultBillToLogic" : 0,
"TurnKickOffAuto" : false,
"TurnKickOffLagDays" : 0,
"TurnKickOffOnDays" : 0,
"EarliestSlot" : 0,
"LatestSlot" : 0,
"SlotsCount" : 0,
"IsPrecalculatedSchedule" : false,
"AllowTimePreference" : false,
"TurnTemplateId" : 0,
"IsmSpecGroupId" : 0,
"IsmUrl" : "",
"ExcludeNonCompliantProviders" : "InheritGlobalSettings",
"IsNteAuto" : true,
"IsRemoved" : false,
"ConcurrencyId" : 13,
"Id" : 1009,
"PerformDeletion" : false,
"IsNew" : false
},
"Employee" : {
"FirstName" : "",
"LastName" : "",
"DisplayAs" : "",
"AccessToAllWorkZones" : false,
"LanguageId" : 0,
"ActorTypeId" : "Unknown",
"Username" : "",
"DtPwdChange" : "0001-01-01T00:00:00",
"Instructions" : "",
"WonMemberId" : 0,
"WonLocationId" : 0,
"WonServiceRadius" : 0,
"IsElectronicPayment" : false,
"ProviderStatusId" : "NA",
"LabelId" : 0,
"FreeTextAllowed" : false,
"RadiusUnit" : "Unknown",
"Password" : "",
"Number" : "",
"JobTitle" : "",
"FederalId" : "",
"ExternalId" : "",
"ForcePasswordReset" : false,
"TaxWarnOnly" : false,
"PriceLists" : [ ],
"CustomFields" : [ ],
"BillAtZero" : false,
"IsSupplier" : false,
"ProviderTypeId" : "Regular",
"ContactAddresses" : [ ],
"Teams" : [ ],
"WorkZones" : [ ],
"Portfolios" : [ ],
"CustomerGroups" : [ ],
"Specialties" : [ ],
"PayRates" : [ ],
"StockLocations" : [ ],
"Services" : [ ],
"AlertSubscriptions" : [ ],
"TaxExempt" : false,
"LimitAssignmentByPortfolioId" : 0,
"IsRemoved" : false,
"ConcurrencyId" : 5,
"Id" : 532,
"PerformDeletion" : false,
"IsNew" : false
},
"Duration" : 0,
"VendorNte" : {
"CurrencyTypeId" : "AUD",
"Value" : 0.0
},
"Specialty" : {
"DisplayAs" : "",
"WONServiceId" : 0,
"Instructions" : "",
"Currencies" : [ ],
"IsNteAuto" : true,
"IsRemoved" : false,
"ConcurrencyId" : 6,
"Id" : 10011,
"PerformDeletion" : false,
"IsNew" : false
},
"PoNumber" : "",
"SubType" : {
"TypeId" : "Unknown",
"IsDefSR" : false,
"IsDefBasic" : false,
"IsRemoved" : false,
"ConcurrencyId" : 4,
"Id" : 259,
"PerformDeletion" : false,
"IsNew" : false
},
"Customer" : {
"DisplayAs" : "",
"Name" : "",
"Dba" : "",
"Instructions" : "",
"TenantCode" : "",
"TaxExempt" : false,
"Spaces" : [ ],
"Contacts" : [ ],
"CustomFields" : [ ],
"Notes" : [ ],
"Addresses" : [ ],
"GroupsBridge" : [ ],
"ApprovalScopes" : [ ],
"IsRemoved" : false,
"ConcurrencyId" : 0,
"Id" : 3,
"PerformDeletion" : false,
"IsNew" : false
},
"ContactName" : "Contact Name",
"WonId" : 0,
"IsWarranty" : false,
"FlagId" : 0,
"TimeZone" : 255,
"CurrencyTypeId" : "AUD",
"LastActionDate" : "2022-02-08T09:53:05.3010762",
"DtCreated" : "2022-02-08T09:53:05.3010762",
"DtDue" : "2022-02-10T16:00:00",
"DtAcknowledgeBy" : "2022-02-10T10:00:00",
"AcknowledgeByUtc" : "2022-02-09T23:00:00Z",
"LastActionDateUtc" : "2022-02-07T22:53:05.3010762Z",
"CreatedDateUtc" : "2022-02-07T22:53:05.3010762Z",
"DueDateUtc" : "2022-02-10T05:00:00Z",
"LastAction" : {
"Id" : 154095,
"WorkOrderId" : 0,
"BillStatus" : "NotBilled",
"PerformDeletion" : false,
"IsNew" : false
},
"Items" : [ ],
"EquipmentWorkedOn" : [ ],
"Notes" : [ ],
"Assignments" : [ ],
"Procedures" : [ ],
"Documents" : [ ],
"CustomFields" : [ ],
"Verifications" : [ ],
"CheckInOuts" : [ ],
"ActionLogRecords" : [ ],
"InductionAndSafetyStatusID" : "NotRequired",
"Flags" : [ ],
"ConcurrencyId" : 1,
"Id" : 154095,
"PerformDeletion" : false,
"IsNew" : false
}
},
"RequestId" : "1234"
}
SpaceCreateCommand
A Space entity represents a physical/postal location to deliver service. One or more Spaces may be created for a single Customer. When executing this command, a reference to an existing Customer Entity is requred. Be certain to visit the GET (Retrieve) and QueryExpression sections before attempting SpaceCreateCommand.
Database growth warning!
The creation of a Space entity is special because it involves the application of an Asset Template to the active asset inventory in addition to the typical record storage. Asset Templates may be quite detailed depending on the level of granularity of the asset structure for a particular Company. Asset Template complexity varies widely from one Company to another.
The Space create tab demonstrates a direct reference through CustomerId, and indirect reference through NewUnitSpecifier.UnitFloorPlan which is a refenced to the name of a Unit-level AssetTemplate that has been defined in this Company.
The Response tab contains CommandResult example which in turn contains a JSON representation of the Entity that was just created, including any auto-calculated values such as Space.Asset.Id.
POST <<AM Host Name>>/api/v1/cmd/SpaceCreateCommand HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMi4yNDYuZjkxYyIsIlZhbHVlVHlwZSI6Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hI3N0cmluZyIsIklzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSIsIk9yaWdpbmFsSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIn0seyJUeXBlIjoidXJuOm9hdXRoOnNjb3BlIiwiVmFsdWUiOiIiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6IkF1ZCIsIlZhbHVlIjoiMjQ2IiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifV0sIlByb3BlcnRpZXMiOnsiRGljdGlvbmFyeSI6eyIuaXNzdWVkIjoiVHVlLCAwOCBGZWIgMjAyMiAwMzo0NzoyMCBHTVQiLCIuZXhwaXJlcyI6IlR1ZSwgMDggRmViIDIwMjIgMDQ6MDc6MjAgR01UIn19fQ<---->AQHglEo4Oyyi6Jl7_jFNBJw4YeyaZHWVogvqRCvOUZYGEWSsAqV2-9xrrPO658AOuVDRRhUKGa4asI_GzX77oWHCi9WGIPYcfKBYXPqpQPr19EF4q7Dpj2JaCc36chBaf5iynZrlRSOcO82Uge69R0YoY4d6xZbGyYi5OpvTD2I9vdmuT_lyh1l67HKnDaFqWvReIlVWw5hNPU24emAHKdkVdKw43_PwGmt3G5z72gkCOV95ibDyeRVIMzB_TURzvFKNcp1geVaDcNa73HHDH0V-syCA2j2Pwzqa-wUjtYjVRsQumIUw79LDdDVUcgvgUI_yfgujsZmMYLrAdGi12Q
Content-Length: 679
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Command" : {
"CustomerId" : "2",
"StartDate" : "2022-01-01T00:00:00",
"IfUnitAlreadyExists" : "Reuse",
"Instructions" : "This Speace was created to illustrate the SpaceCreateCommand Request",
"NewUnitSpecifier" : {
"UnitName" : "Test Space 01",
"UnitFloorPlan" : "PostPal",
"StreetAddress" : {
"ActorTypeId" : "CommLeaseSpace",
"TypeId" : "Primary",
"Street" : "1234 Main St",
"Street2" : "P.O.Box 1234",
"City" : "Dallas",
"State" : "TX",
"Zip" : "75234",
"Country" : "US"
}
}
}
}
{
"CommandResult" : {
"NewSpace" : {
"CustomerId" : 2,
"Asset" : {
"Name" : "",
"ModelId" : 0,
"Orphan" : false,
"TypeId" : "Unknown",
"ParentId" : 0,
"RootId" : 0,
"IsTemplate" : false,
"Documents" : [ ],
"IsOffline" : false,
"IsLocked" : false,
"Attributes" : [ ],
"Id" : 297496,
"PerformDeletion" : false,
"IsNew" : false
},
"StartDate" : "2022-01-01T00:00:00",
"WorkZone" : {
"DisplayAs" : "",
"TimeZone" : 0,
"LanguageId" : 0,
"WoNumberPrefix" : "",
"Entity" : "",
"SchedulingWindow" : 0,
"NoIncompleteProcedure" : false,
"AccessOptionsMask" : 0,
"Number" : "",
"AdvanceNotice" : 0,
"WoNumberDigits" : 0,
"RoundApptTimeTo" : 0,
"WorkPlanAutoCancel" : false,
"WorkPlanChildResolution" : false,
"WorkPlanAutoDependency" : false,
"CpThemeId" : 0,
"DefaultAccess" : "Unknown",
"AutoAssignEnabled" : false,
"BackupRoutingId" : "Unassigned",
"NoIncompleteItem" : false,
"UiShowProvidersFirst" : false,
"CurrencyTypeId" : "Unknown",
"IsOffline" : false,
"ContactAddresses" : [ ],
"CustomFields" : [ ],
"Portfolios" : [ ],
"SlaValues" : [ ],
"Teams" : [ ],
"BizHours" : [ ],
"EscalationRules" : [ ],
"SpecDispatchRules" : [ ],
"OnCallRules" : [ ],
"Responsibilities" : [ ],
"UseBizHours" : false,
"UseHolidays" : false,
"UseOnCall" : false,
"UseEscalation" : false,
"DefaultBillToLogic" : 0,
"TurnKickOffAuto" : false,
"TurnKickOffLagDays" : 0,
"TurnKickOffOnDays" : 0,
"EarliestSlot" : 0,
"LatestSlot" : 0,
"SlotsCount" : 0,
"IsPrecalculatedSchedule" : false,
"AllowTimePreference" : false,
"TurnTemplateId" : 0,
"IsmSpecGroupId" : 0,
"IsmUrl" : "",
"ExcludeNonCompliantProviders" : "InheritGlobalSettings",
"IsNteAuto" : true,
"IsRemoved" : false,
"ConcurrencyId" : 54,
"Id" : 2,
"PerformDeletion" : false,
"IsNew" : false
},
"StatusId" : "Current",
"Addresses" : [ ],
"Instructions" : "This Speace was created to illustrate the SpaceCreateCommand Request",
"IsRemoved" : false,
"ConcurrencyId" : 2,
"Id" : 3081,
"PerformDeletion" : false,
"IsNew" : false
}
}
}
ApStatusChangeCommand
WorkOrderCost.ApStatus defines the state of an Invoice created by (or on behalf of) a Service Pro and is being processed in the Corrigo Enterprise back office application. Some AP Statuses are standard across all Corrigo Companies and represent a specific behavior (like Submitted or Disputed). Other AP Statuses may be defined for specific workflow and customized for a single Company. Any integrated workflow solution that includes Service Pros will likely use this command to implement business rules associated with invoice submittal, authorization, dispute and export.
POST <<AM Host Name>>/api/v1/cmd/ApStatusChangeCommand HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMi4yNDYuZjkxYyIsIlZhbHVlVHlwZSI6Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hI3N0cmluZyIsIklzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSIsIk9yaWdpbmFsSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIn0seyJUeXBlIjoidXJuOm9hdXRoOnNjb3BlIiwiVmFsdWUiOiIiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6IkF1ZCIsIlZhbHVlIjoiMjQ2IiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifV0sIlByb3BlcnRpZXMiOnsiRGljdGlvbmFyeSI6eyIuaXNzdWVkIjoiTW9uLCAwNyBGZWIgMjAyMiAyMjozNTozMSBHTVQiLCIuZXhwaXJlcyI6Ik1vbiwgMDcgRmViIDIwMjIgMjI6NTU6MzEgR01UIn19fQ<---->PVtZBKow5OQuVbRYwyhiTAGFKmaRvEw0lVeq7apW4vdS0uXdC1fOb2aPz12QwODEev8H_Pi6wRnXz0aH7ysadiyZKJqQSgzknb-kphpTNvbvJBHbw5TaydRN4-3N--M5_QERguFrJjwWTc2AkCxVf78QYcLZrXCeGuExAQ6gO2VtBmlxC-ZDG6d1Bv33DVR4F9LHfi6bKKqfAlR8VknNqIAgnYJnkWBNipACsQejc4vD4DE7WOYGdmiWI0xLy1CBnQh9K_lEpP0kuO8v5atDRWJoe9ymDzT9b5_Cd7DXYqbQO1Zt7YnH7o_oxO3zeBxCyUJ3KFSclaqghK6TDDntWA
Content-Length: 860
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Command": {
"WorkOrderid": 15,
"VendorInvoiceStatusId": 2
},
"RequestId": "223-1234"
}
SendWorkOrderCommand
Connected Pros do not receive notification of assignment to WorkOrder until the Send action is invoked. This can be automated through this command.
POST <<AM Host Name>>/api/v1/cmd/SendWorkOrder HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMi4yNDYuZjkxYyIsIlZhbHVlVHlwZSI6Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hI3N0cmluZyIsIklzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSIsIk9yaWdpbmFsSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIn0seyJUeXBlIjoidXJuOm9hdXRoOnNjb3BlIiwiVmFsdWUiOiIiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6IkF1ZCIsIlZhbHVlIjoiMjQ2IiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifV0sIlByb3BlcnRpZXMiOnsiRGljdGlvbmFyeSI6eyIuaXNzdWVkIjoiTW9uLCAwNyBGZWIgMjAyMiAyMjozNTozMSBHTVQiLCIuZXhwaXJlcyI6Ik1vbiwgMDcgRmViIDIwMjIgMjI6NTU6MzEgR01UIn19fQ<---->PVtZBKow5OQuVbRYwyhiTAGFKmaRvEw0lVeq7apW4vdS0uXdC1fOb2aPz12QwODEev8H_Pi6wRnXz0aH7ysadiyZKJqQSgzknb-kphpTNvbvJBHbw5TaydRN4-3N--M5_QERguFrJjwWTc2AkCxVf78QYcLZrXCeGuExAQ6gO2VtBmlxC-ZDG6d1Bv33DVR4F9LHfi6bKKqfAlR8VknNqIAgnYJnkWBNipACsQejc4vD4DE7WOYGdmiWI0xLy1CBnQh9K_lEpP0kuO8v5atDRWJoe9ymDzT9b5_Cd7DXYqbQO1Zt7YnH7o_oxO3zeBxCyUJ3KFSclaqghK6TDDntWA
Content-Length: 860
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Command": {
"WorkOrderId": 1000
},
"RequestId": "4345-093"
}
VerifyWorkCommand
For some but not all Corrigo Enterprise systems, after a WorkOrder is completed by the assignee it is then Verified by responsible party who provides a rating.
POST <<AM Host Name>>/api/v1/cmd/VerifyWorkCommand HTTP/1.1
Accept-Encoding: gzip,deflate
CompanyName: <<Sample Company>>
Content-Type: application/json
Authorization: Bearer eyJBdXRoZW50aWNhdGlvblR5cGUiOiJCZWFyZXIiLCJOYW1lQ2xhaW1UeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlJvbGVDbGFpbVR5cGUiOiJodHRwOi8vc2NoZW1hcy54bWxzb2FwLm9yZy93cy8yMDA1LzA1L2lkZW50aXR5L2NsYWltcy9uYW1lIiwiQ2xhaW1zIjpbeyJUeXBlIjoiaHR0cDovL3NjaGVtYXMueG1sc29hcC5vcmcvd3MvMjAwNS8wNS9pZGVudGl0eS9jbGFpbXMvbmFtZSIsIlZhbHVlIjoiY2VhcGljbGllbnQuMi4yNDYuZjkxYyIsIlZhbHVlVHlwZSI6Imh0dHA6Ly93d3cudzMub3JnLzIwMDEvWE1MU2NoZW1hI3N0cmluZyIsIklzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSIsIk9yaWdpbmFsSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIn0seyJUeXBlIjoidXJuOm9hdXRoOnNjb3BlIiwiVmFsdWUiOiIiLCJWYWx1ZVR5cGUiOiJodHRwOi8vd3d3LnczLm9yZy8yMDAxL1hNTFNjaGVtYSNzdHJpbmciLCJJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkiLCJPcmlnaW5hbElzc3VlciI6IkxPQ0FMIEFVVEhPUklUWSJ9LHsiVHlwZSI6IkF1ZCIsIlZhbHVlIjoiMjQ2IiwiVmFsdWVUeXBlIjoiaHR0cDovL3d3dy53My5vcmcvMjAwMS9YTUxTY2hlbWEjc3RyaW5nIiwiSXNzdWVyIjoiTE9DQUwgQVVUSE9SSVRZIiwiT3JpZ2luYWxJc3N1ZXIiOiJMT0NBTCBBVVRIT1JJVFkifV0sIlByb3BlcnRpZXMiOnsiRGljdGlvbmFyeSI6eyIuaXNzdWVkIjoiTW9uLCAwNyBGZWIgMjAyMiAyMjozNTozMSBHTVQiLCIuZXhwaXJlcyI6Ik1vbiwgMDcgRmViIDIwMjIgMjI6NTU6MzEgR01UIn19fQ<---->PVtZBKow5OQuVbRYwyhiTAGFKmaRvEw0lVeq7apW4vdS0uXdC1fOb2aPz12QwODEev8H_Pi6wRnXz0aH7ysadiyZKJqQSgzknb-kphpTNvbvJBHbw5TaydRN4-3N--M5_QERguFrJjwWTc2AkCxVf78QYcLZrXCeGuExAQ6gO2VtBmlxC-ZDG6d1Bv33DVR4F9LHfi6bKKqfAlR8VknNqIAgnYJnkWBNipACsQejc4vD4DE7WOYGdmiWI0xLy1CBnQh9K_lEpP0kuO8v5atDRWJoe9ymDzT9b5_Cd7DXYqbQO1Zt7YnH7o_oxO3zeBxCyUJ3KFSclaqghK6TDDntWA
Content-Length: 860
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.5.2 (Java/16.0.1)
{
"Command": {
"WorkOrderId": 150,
"WoRatingId":"Positive",
"Comment":"Good Service"
},
"RequestId": "566870733"
}
Applying to other Commands
Any Command in the API may be invoked by applying the same principles described above. Since most commands both depend upon and have direct impact on workflow, preparation for testing such solutions can be complicated by variations of feature use across Companies. Some configurations may be rich with custom Flags or Reason codes. Others may have custom Cost Statuses that factor into authorization. It is critical to work with workflow experts when building workflow solutions.
If you need help with workflows on your development project please ask for help through the Discussions page and JLLT moderators will try to help.
