Skip to content

Claim data retrieval

This operation groups the read-oriented calls on ClaimDataApiClient: single and bulk claim lookup, MCO/condition/contact retrieval, financial data, MCO claims, vocational details, and legacy non-converted claims, all served through the shared cached-request pipeline.

Field Value
Operation ID OP-SDG-03
Trigger Caller invokes a ClaimDataApiClient retrieval method
Inputs Claim id or claim number, list of ids (bulk), financial query options (exclude, count)
Outputs ClaimData, ClaimsData, BulkClaimData, ClaimFinancialData, VocationalDetails, NonConvertedClaim, or related DTOs
Primary components ClaimDataApiClient
Entry point Data/SAIF.Data.Guidewire/Clients/ClaimDataApiClient.cs

Steps

  1. Resolve the client's base URL (cc.claimdata.api.url.v1) and Basic-auth header (cc.gwcreds).

Origin: Step 1 is implemented in Resolve base URL and authenticate (SAIF.Data.Guidewire) and executed on behalf of this operation. 2. Get a single claim: GET claims/id/{id} or GET claims/{claimNumber}, executed through the cached-request helper. (SDG-BR-003) 3. Get claims in bulk: POST claims with a list of ids. - If the input list is empty, return an empty result without calling the API. (SDG-BR-012) 4. Get MCO, condition, and contact data: GET claims/{id}/mco, GET claims/{id}/conditions, and GET claims/{id}/contacts. 5. Get financial data: GET claims/{id}/financials?excludeClaimPayments={bool}&excludeClaimReserves={bool}&excludeClaimRecoveries={bool}&excludeClaimFinancialSummary={bool} (with an optional &count={numberOfTransactions}) for payments, reserves, and recoveries. 6. Get MCO claims: POST mco/claims?claimsOnly={bool}. 7. Get vocational details: GET claims/{id}/vocationaldetails. 8. Get a legacy claim not converted to Guidewire: GET nonconvertedclaims/{claimNumber}.

Process flow

The following diagram visualizes this operation's control flow.

flowchart TD
    Start([Caller invokes a retrieval method]) --> S1["Resolve base URL and<br>Basic-auth header"]
    S1 --> Which{"Which retrieval?"}
    Which -->|Single claim| S2["GET claims/id/{id} or<br>claims/{claimNumber}"]
    Which -->|Bulk claims| S3{"Id list empty?"}
    S3 -->|Yes| EndEmpty(["Return empty result,<br>no API call"])
    S3 -->|No| S3b["POST claims with id list"]
    Which -->|MCO / conditions / contacts| S4["GET claims/{id}/mco,<br>conditions, contacts"]
    Which -->|Financials| S5["GET claims/{id}/financials"]
    Which -->|MCO claims| S6["POST mco/claims"]
    Which -->|Vocational details| S7["GET claims/{id}/vocationaldetails"]
    Which -->|Legacy claim| S8["GET nonconvertedclaims/{claimNumber}"]
    S2 --> EndOk([Return cached/deserialized DTO])
    S3b --> EndOk
    S4 --> EndOk
    S5 --> EndOk
    S6 --> EndOk
    S7 --> EndOk
    S8 --> EndOk

Failure and edge-case behavior

  • An empty bulk claim id list returns an empty result without an HTTP call (SDG-BR-012).
  • Cached read calls reuse a response for up to MaxCacheDuration (default 30 seconds) unless UseCache is false (SDG-BR-003).

Sources

  • Data/SAIF.Data.Guidewire/Clients/ClaimDataApiClient.cs
  • Data/SAIF.Data.Guidewire/Clients/HttpClientBase.cs
  • Data/SAIF.Data.Guidewire/Models/ClaimDataApi/ClaimData.cs
  • Data/SAIF.Data.Guidewire/Models/ClaimDataApi/ClaimsData.cs
  • Data/SAIF.Data.Guidewire/Models/ClaimDataApi/BulkClaimData.cs
  • Data/SAIF.Data.Guidewire/Models/ClaimDataApi/ClaimFinancialData.cs
  • Data/SAIF.Data.Guidewire/Models/ClaimDataApi/VocationalDetails.cs
  • Data/SAIF.Data.Guidewire/Models/ClaimDataApi/NonConvertedClaim.cs