CorrigoService - Web Service

Click here for a complete list of operations.

Retrieve

Retrieves an instance of an entity. Takes two parameters: first of them specifies an entity by identifier and entity type (instance of EntitySpecifier class should be passed); second parameter specifies the set of properties to retrieve (to retrieve all properties, pass a new instance of the AllProperties class). Returns an instance of the CorrigoEntity requested or null if no entity was found. The CorrigoEntity class contains only the properties specified by the input parameter. Use this method to retrieve an instance of the CorrigoNet entity. Your client application must be logged in with sufficient access rights to retrieve a specified object and to retrieve the properties in the specified property list.

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /wsdk/CorrigoService.asmx HTTP/1.1
Host: am-ce98f.corrigo.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://corrigo.com/integration/Retrieve"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <CorrigoNetOptions xmlns="http://corrigo.com/integration/">
      <ImposeConcurrencyId>boolean</ImposeConcurrencyId>
      <CanDeleteMissingEntity>boolean</CanDeleteMissingEntity>
      <LockOnDataRetrieval>Default or ReadUncommitted or ReadCommitted or Snapshot</LockOnDataRetrieval>
    </CorrigoNetOptions>
  </soap:Header>
  <soap:Body>
    <Retrieve xmlns="http://corrigo.com/integration/">
      <entitySpecifier>
        <EntityType>TaxCode or InvoiceDictionaryItem or BillingAccount or WorkOrder or Location or Address or Customer or Invoice or InvoiceLine or CorporateEntity or GLAccount or Payment or PaymentItem or Employee or WorkZone or Space or Task or Disposition or WoItem or CustomFieldDescriptor or CustomField or Organization or Contact or TimePeriod or Specialty or WorkOrderType or CustomerNoteType or RepairCode or AttributeDescriptor or WoActionReasonLookup or WoPriority or WoLastAction or WoNote or Actor or ContactAddress or Address2 or ContactInfo or CustomField2 or Note or WorkOrderCost or WoAssignment or WoOnSite or WoActionLog or WoVerification or WoActionLogProp or FinancialItem or WoQuote or WoEquipment or Blob or DocumentType or Document or Product or LaborCode or WpTree or WoEstimate or ToDoItem or LinkCustomerAndGroup or LinkContactAndGroup or AssetInfo or PmSchedule or PmItem or Contract or TaxRegion or TaxRegionItem or PriceList or PriceListItem or ChargeCodeLookup or CustomFieldOption or Model or LinkUserAndSpecialty or LinkUserAndCustomerGroup or LinkUserAndWorkZone or LinkUserAndPortfolio or LinkUserAndTeam or UserPayRate or UserCertification or LinkUserAndStockLocation or LinkProviderPriceList or LinkProviderAndService or Role or AlertScope or AlertSubscription or AssetTree or AttributeOption or Team or LinkTeamAndWorkZone or LinkPortfolioAndWorkZone or BusinessHours or Holiday or SpecDispatchRule or EscalationRule or OnCallRule or Responsibility or Warranty or AssetAttribute or SpecialtyMoneyValues or ContactMoneyValues or TaskMoneyValues or UserPayRateMoneyValues or RoleMoneyValues or Portfolio or AssetTemplate or AssetSystem or ProductCategory or LinkProductAndSupplier or ProductMoneyValues or ApInvoiceStatus or TimeCardWeek or TimeCard or TimeCardItem or ProviderCoi or ResponsibilityType or ToDoType or ApprovalTemplateStep or ApprovalTemplate or ProcedureTemplateStep or ProcedureFlagReason or ProcedureTemplate or WoProcedureStep or WoProcedure or StockLocation or ReplenishmentOrder or ReplenishmentOrderItem or ApprovalScope or CustomFieldAutocompleteOption or TimeOff or SlaValuesOverride or Turn or LinkModelAndAttribute or BillToOption or PrintoutTemplate or InvoiceLog or QuoteOrEstimateItem or MaterialTransaction or MaterialTransactionItem or StockLocationInventoryDetails or InternalCostStatus or WoFlag or ProcedureCategory or LinkProcedureCategoryAndTemplate or LinkProductAndQtyAttribute or RequiredDocCategory or WorkTemplate or Proposal or WorkOrderCostCategory or WoSchedule or RcsCircuit or RcsAction or RcsCylinder or LinkCommunityAndRcsCylinder or LinkEmployeeAndRcsCylinder or RcsLeakRateLog or BlackoutDay</EntityType>
        <Id>int</Id>
      </entitySpecifier>
      <propertySet />
    </Retrieve>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <RetrieveResponse xmlns="http://corrigo.com/integration/">
      <RetrieveResult>
        <Id>int</Id>
        <PerformDeletion>boolean</PerformDeletion>
      </RetrieveResult>
    </RetrieveResponse>
  </soap:Body>
</soap:Envelope>