Click or drag to resize

CorrigoService.Commands Namespace

 
Classes
 ClassDescription
Public classAddChildWorkOrderResponse Adding Child WorkOrder Responses
Public classAddChildWorkOrderRoutine Add ChildWork OrderRoutine
Public classApStatusChangeCommand ApStatus Change Command
Public classApSubmitPaymentCommand ApSubmit Payment Command
Public classAssetMatchByTaskCodeCommand This command allows integration client to search for assets under specified parent; with two additional criteria: (a) only assets belonging to specified categories included into the search; (b) asset model must have task with the specified code.
Public classBaseWoActionCommand Base Word Order Action Commands
Public classCommandRequest Specifies the command request abstract class used in the Execute method.
Public classCommandResponse Specifies the command response abstract class used as return value in the Execute method.
Public classCompositeCommand CompositeCommand.
Public classCompositeCommandResponse Contains result of an CompositeCommand.
Public classConvertMoneyValuesCommand This command converts given value from one currency into another.
Public classConvertMoneyValuesResponse Convert MoneyValues Response
Public classCostStatusChangeCommand Cost Status Change Command
Public classCreateCommand Represents a command for creating an instance of a Corrigo entity. Returns an OperationCommandResponse that contains an identifier and a type of the newly created entity or error information in case of an error. The command is not applicable for entities WorkOrder, WorkZone, Space - which have their own create commands.
Public classCreateWoPrintoutCommand Command returns CreateWoPrintoutResponse.
Public classCreateWoPrintoutResponse Create WoPrintout Response
Public classCustomerResponse Customer Response
Public classDeleteCommand Represents a command for deleting an existing entity instance. Returns an OperationCommandResponse that contains an identifier and a type of the deleted entity or error information in case of an error.
Public classEmployeeResponse Employee Response
Public classFinancialStatusChangeResponse Financial Status Change Response
Public classGeneratePmWoCommand This command forces "manual" PM WO generation for the specified PM Schedule. Anticipated usage is automated testing to simulate WON workload.
Public classGetCompanySettingCommand Get CompanySettings
Public classGetCompanySettingResponse 
Public classGetCompanyWsdkUrlCommand Converts a Company Name argument into a fully-qualified URL for WSDK calls.
Public classGetCompanyWsdkUrlResult Get Company WsdkUrl Result
Public classGetCustomerByAssetCommand Get Customer By Asset
Public classGetDocDownloadUrl Reference to Get Document Download Url
Public classGetDocDownloadUrlCommand Get Doc Download Url
Public classGetDocDownloadUrlTypeResponse Reference to Get Document Download UrlType Response
Public classGetLicensedProvidersResponse Reference to Get Licensed Providers Response
Public classGetLicensedProvidersRoutine This command builds a list of licensed providers who are suitable WO assignees by a number of parameters such as Specialty, Customer, Postal Code and timestamp
Public classGetPreferredAssigneesResponse list of Employee entities
Public classGetPreferredAssigneesRoutine This command returns list of so-called “preferred assignees” based on Specialty and other parameters. Depending on how instance is configured, this list contains either licensed providers or resources from Specialty-based dispatch list associated with Work Zone/Portfolio.
Public classGetProcedureStepsDocumentsResponse Get Procedure Steps Documents Response
Public classGetProcedureStepsDocumentsRoutine This command returns list of documents attached to all procedure steps with temporary URLs to AWS to access these documents.
Public classGetTimeCardCommand It takes provided User ID and date as parameters and either returns existing Time Card Week record, or creates and returns new one matching these parameters.
Public classInvoiceDisputeCommand Invoice Dispute Command
Public classInvoiceRecallCommand This action is supported for posted Customer Invoices linked to WON. It’s used when provider needs to “un-post” Customer Invoice to make additional changes.
Public classLoginResponse LoginResponse
Public classMatchAssetsResponse MatchAssetsResponse
Public classMaterialTransactionCommitCommand Material Transaction CommitCommand
Public classMaterialTransactionCommitResponse Material Transaction CommitResponse
Public classOperationCommandResponse Contains result of an entity operation like Create, Update or Delete.
Public classPortfolioDeleteCommand This command deletes Portfolio
Public classPostPaymentCommand Represents a command to set payment state as Posted.
Public classRestoreCommand Represents a command for restoring previously deleted entity instance. Works only for some entities which support this feature. Returns an OperationCommandResponse that contains an identifier and a type of the restored entity or error information in case of an error.
Public classRetrieveWithCurrencyTypeCommand This command retrieves currency values for one or more multi-currency entity (Contact, Role, Task, Specialty etc.) by specified currency type. If value by specified currency type is missing, currency conversion will be executed.
Public classRetrieveWithCurrencyTypeResponse Retrieve With CurrencyType Response
Public classSendWorkOrderCommand This command sends a Work Order to provider it currently assigned to. WoRecallCommand can be used to alter send message.
Public classSendWorkOrderResponse Reference to Send WorkOrder Response
Public classSetWorkOrderDependencyCommand This command is used when dependency between sibling Work orders is set, modified or cleared. Returns master WorkOrder as result.
Public classSpaceCreateCommand This command allows integration client creating Space and its Unit asset at the same time; while specifying new Unit’s location inside work zone and asset templates for Unit itself, its floor and building.
Public classSpaceCreateCommandResponse Space Create Command Response
Public classTimeCardActionCommand It modifies state of Time Card entity defined by pair (Employee, Week).
Public classTimeCardActionResponse TimeCard ActionResponse.
Public classUpdateCommand Represents a command for updating an existing entity instance. Returns an OperationCommandResponse that contains an identifier and a type of the updated entity or error information in case of an error.
Public classUpdateInvoiceStateCommand Represents a command for modification invoice state.
Public classUpdateInvoiceStateCommandResponse Response of UpdateInvoiceStateCommand
Public classUpdateWoInductionAndSafetyStatusCommand Update Work Order Induction And Safety StatusCommand
Public classUserOrProviderSuspendCommand User Or Provider SuspendCommand
Public classUserSignInInfo Reference to User SignIn
Public classUserSignInInfoCommand User SignIn InfoCommand
Public classUserSignInInfoResponse Reference to User SignIn InfoResponse
Public classVerifyWorkCommand This command create new WO verification record. This operation has been packaged into custom command to avoid complications such as limiting modifications integration clients can make to Work Verification records; and validating input.
Public classVerifyWorkResponse Reference to VerifyWork entity
Public classWoActionResponse Reference to WorkOrder entity; contains up-to-date WO state after WO action finishes. Only scalar properties are returned.
Public classWoAddProcedureCommand WorkOrder AddProcedureCommand
Public classWoAssignCommand Allows to assign Work Order to some user. Requires ChangeAssigmentMode (if a Workorder is not assigned to anyone - use Primary mode), Employee.Id of user for an assignment
Public classWoAutoAssignRoutine Reference to WorkOrder Auto Assign Routine
Public classWoCancelCommand Cancels Work Order. ActionReasonId - The Id of a reason from cancel reasons.
Public classWoClearFlagsCommand WorkOrder ClearFlagsCommand
Public classWoCompleteCommand Completes Work Order. Assignment required.
Public classWoCopyCommand WorkOrder CopyCommand
Public classWoCreateCommand Reference to WorkOrder CreateCommand.
Public classWoFlagCommand Is used to set flag to a Work Order. Contains reason and comment.
Public classWoLastModificationCommand Represents a command for retrieving WO last modification date. The WO last modification could be the status change, notes addition, invoices change, etc.
Public classWoLastModificationResponse WorkOrder Last Modification Response
Public classWoMessageCommand Sends Message. This command can be used only for Work Order sent to a connected Service Pro.
Public classWoOnHoldCommand Put Work Order 'On Hold'.
Public classWoPauseCommand Changes work order state from 'In Progress' to 'Paused'. Assignment required.
Public classWoPickUpCommand Changes work order state from 'New' to 'Open'. Assignment is required.
Public classWoProcedureStepResponse Executes commands in sequential manner until first error. Returns an CompositeCommandResponse that contains a list of a CommandRequest for successfully completed commands or error information in case of an error.
Public classWoRecallCommand Recalls Work Order. Can be used only to recall a Work Order sent to a connected Service Pro.
Public classWoReopenCommand Reopens work order after 'Close', 'On Hold', 'Cancel' statuses.
Public classWorkZoneCommandResponse WorkZone CommandResponse.
Public classWorkZoneCreateCommand This command is used to create new Work Zone. Please note this command accepts new (unsaved/transient) instance of WorkZone entity for which “insert” and/or “update” operations are not allowed, under normal circumstances.Internally, integration services never execute CreateCommand/UpdateCommand for this entity, so this approach works.
Public classWorkZoneDefaultCommand This command WorkZone DefaultCommand.
Public classWorkZoneDeleteCommand This command deletes Work Zone
Public classWorkZoneOfflineCommand This command changes Work Zone status to Offline.
Public classWorkZoneOnlineCommand This command changes Work Zone status to Online.
Public classWoScheduleRoutine This command is used primarily to prepare scheduling data for the new Work Order: flag “Possibly covered by warranty”, PTE, Priority, Specialty, Duration, GL Account, Vendor NTE, due date etc. It can be also executed for existing Work Order. Allows assign date-time fields such as: creation date, due date, on site by date, duration of the Work Order.
Public classWoSetFlagsCommand WorkOrder SetFlagsCommand
Public classWoStartCommand Changes work order state from 'Open' to 'In Progress'. Assignment is required.
Public classWoUpdateProcedureStepCommand Work order Update Procedure Step Command
Enumerations
 EnumerationDescription
Public enumerationApiTypes Api Types