アクティブなクレームとアーカイブ済みクレームの検索
デフォルトでは、GET /claims エンドポイントは、呼び出し元に関連付けられていてアーカイブされていないクレームのみを返します。検索対象クレームが、自分に関連付けられていないクレーム、アーカイブ済みクレーム、または GET /claims の結果から除外されているクレームの場合、以下のいずれかのエンドポイントを使用できます。
- POST
/claim/v1/search/claims-v2 - POST
/claim/v1/search/claims-freetext
/claim/v1/search/claims-v2 エンドポイントを使用すると、呼び出し元に関連付けられていないクレームとアーカイブ済みのクレームを検索できます。注意点として、呼び出し元がアクセス権限を持たないクレームが検索結果に表示されます。ところが、呼び出し元は GET /claims/{claimId} エンドポイントを使用してこれを表示することはできません。
/claim/v1/search/claims-freetext を使用しても、呼び出し元に関連付けられていないクレームとアーカイブ済みクレームを検索できます。ただし、フリーテキスト検索が有効になっている場合のみです。フリーテキスト検索の使用方法については、『アプリケーションガイド』を参照してください。
/claim/v1/search/claims もあります。Guidewire ではこのエンドポイントを非推奨にしました。後方互換性は保たれますが、このエンドポイントの新たな使用は推奨されなくなりました。POST /claim/v1/search/claims-v2 により、非推奨エンドポイントの全機能が実現されており、追加の要求パラメータや詳細な応答ペイロードにも対応し、アーカイブ済みのクレームを含めることができます。クレーム検索の要求ペイロード
POST /claim/v1/search/claims-v2 呼び出しの要求オブジェクトには本文を含める必要があります。この本文では、以下の構文を使用して検索パラメータを指定する必要があります。
{
"data": {
"attributes": {
"archivedSearch": booleanValue,
"claimNumber": "stringValue",
"companyName": "stringValue",
"firstName": "stringValue",
"lastName": "stringValue",
"nameSearchType": {
"code": " ClaimSearchNameSearchTypeCode ",
},
"policyNumber": "stringValue",
"taxId": "stringValue"
}
}
}
最小限の要求ペイロードでは以下のいずれかのフィールドを指定する必要があります。
companyName フィールドと firstName/lastName フィールドを同じ要求ペイロードに含めることはできません。
claimNumbercompanyNamenameSearchType(オプション)
firstNamelastNamenameSearchType(オプション)
policyNumbertaxIDnameSearchType(オプション)
例えば、次のペイロードは、保険証券番号 54-123456 に関連付けられたすべてのクレームを検索します。
POST /claim/v1/search/claims-v2
{
"data": {
"attributes": {
"policyNumber": "54-123456"
}
}
}
次のペイロードでは、保険金請求者の名が「Ray」で姓が「Newton」であるすべてのクレームを検索します。
{
"data": {
"attributes": {
"firstName": "Ray",
"lastName": "Newton"
}
}
}
フリーテキスト検索の要求ペイロード
POST /claim/v1/search/claims-freetext 呼び出しの要求オブジェクトには本文を含める必要があります。この本文では、フリーテキスト検索を使用する検索パラメータを指定する必要があります。フィールド name は、フリーテキスト検索インデックスから結果を返します。次に例を示します。
{
"data": {
"attributes": {
"address": {
"addressLine1": "1313 Monroe Lane",
"city": "Pomona",
"country": "US",
"state": {
"code": "CA",
}
},
"name": "Ray Newton",
"nameSearchType": {
"code": "any",
},
"phoneNumber": "555 413 4545"
}
}
}
フリーテキスト検索の使用方法については、『ClaimCenter アプリケーションガイド』を参照してください。
アーカイブ済みクレームの検索
アーカイブ済みクレームを検索するには、フィールド archivedSearch を追加し、このフィールドを true に設定します。archivedSearch フィールドを含まない(または archivedSearch が false に設定された)要求ペイロードでは、アクティブなクレームのみを自動検索します。
{
"status": 400,
"errorCode": "com.guidewire.pl.modules.rest.framework.v1.exceptions.OperationNotCurrentlyAllowedException",
"userMessage": "The operation is not currently allowed for this resource"
}名前と納税者番号による検索
ペイロードに firstName、lastName、companyName、taxID のいずれかが含まれる場合、デフォルトの動作では、その名、姓、会社名、納税者番号を持つ保険金請求者が存在するクレームを検索します。
nameSearchType パラメータを使用して、個人の検索もできます。検索対象となる個人は、被保険者とその他の被保険者のいずれかである個人や、クレームに対して役割を持つ個人です。これを行うには、ClaimSearchNameSearchType コードに対して以下のいずれかのコードを指定します。
addinsured(その他の被保険者)any(クレームに対する何らかの役割。その他の被保険者、保険金請求者、被保険者以外の役割を含む)claimant(デフォルトの動作)insured
例えば、次のペイロードでは被保険者の名が「Ray」で姓が「Newton」であるすべてのクレームを検索します。nameSearchType は ClaimSearchNameSearchType コードのフィールドを使用します。
POST /claim/v1/search/claims-v2
{
"data": {
"attributes": {
"firstName": "Ray",
"lastName": "Newton",
"nameSearchType": {
"code": "insured"
}
}
}
}
次のペイロードでは、被保険者の会社名が Wright Construction であるすべてのアーカイブ済みクレームを検索します。
{
"data": {
"attributes": {
"archivedSearch": true,
"companyName": "Wright Construction",
}
}
}
空のクレーム検索の応答ペイロード
システム API では検索パラメータを指定する必要はありませんが、検索パラメータが存在しないと ClaimCenter はクレーム検索を実行しません。検索パラメータを指定せずにクレーム検索を実行しようとすると、ユーザーインターフェイスまたはシステム API 経由で ClaimCenter が次のエラーメッセージを返します。
Please specify Claim #, Policy #, any Contact field, Assigned To Group, Assigned To User, Created By, Cat #, VIN or License Plate
このメッセージは主に、ユーザーインターフェイスのクレーム検索向けです。/claim/v1/search/claims-v2 エンドポイントでは使用できないフィールド(Assigned To Group、Assigned To User、Created By など)に言及しているのはこのためです。
クレーム検索の応答ペイロード
/claim/v1/claims エンドポイントと /claim/v1/claims/{claimId} エンドポイントは、クレームまたはクレームのコレクションを返します。claim/v1/search/claims-v2 エンドポイントは ClaimSearchResultWrapper のコレクションを返します。このため、このエンドポイントは少し異なる構造のペイロードを返します。
次の表は、主な違いについて説明しています。
| 情報 | クレームペイロードの例 | ClaimSearchResultWrapper ペイロードの例 |
|---|---|---|
| クレーム所有者 |
|
|
| クレーム ID |
|
|
| 被保険者 |
|
|
| 保険金請求者 |
|
|
クエリパラメータを使用して応答ペイロードをカスタマイズすることで、デフォルトフィールドを除外し、デフォルト以外のフィールドを含めることができます。詳細については、クエリパラメータを参照してください。
検索対象がアーカイブ済みクレームなのかアクティブなクレームなのかによって、応答ペイロードは異なります。
以下のセクションでは、アーカイブ済みクレームとアクティブなクレームの検索結果の違いについて説明します。
アクティブなクレームの検索結果
次の例では、Bill Kinman さんに関連付けられたすべてのクレームを保険契約者が検索しています。
adjusterName:クレームの担当者ユーザーを示すassignedGroup:クレームにアサインされたグループを示すclaimIDclaimNumberclaimantsのリストflaggedフィールド:担当者がクレームに一意のフラグステートメントを提示したかどうかを示すfuturePayments:送信される支払スケジュールinsuredName- クレームの
LossDate - 総額の
paid - クレームの
policyNumber - クレームに残っている
remainingReserves - クレームの
status:未了かクローズ済みかを示す
{
"count": 1,
"data": [
{
"attributes": {
"adjusterName": "Andy Applegate",
"assignedGroup": "Auto1 - TeamA",
"claimId": "cc:SO",
"claimNumber": "235-53-425891",
"claimants": [
"Bill Kinman"
],
"flagged": true,
"futurePayments": {
"amount": "0.00",
"currency": "usd"
},
"insuredName": "Bill Kinman",
"lossDate": "2021-02-28T00:00:00.000Z",
"paid": {
"amount": "0.00",
"currency": "usd"
},
"policyNumber": "4775949863-02",
"remainingReserves": {
"amount": "0.00",
"currency": "usd"
},
"status": {
"code": "open",
"name": "Open"
}
}
},
アーカイブ済みクレームの検索結果
アーカイブ済みクレームの検索結果はアクティブなクレームの検索結果と類似していますが、アーカイブ関連のフィールドも含まれます。アーカイブ関連のフィールドには以下が含まれます。
- クレームの
archiveState:クレームがアーカイブ済みなのか、アクティブなクレームの状態に戻っているのかを示す - クレームが
archivedであったのかどうか(常に true) archivedAdjuster:アーカイブを実行した担当者を示すclaimInfoID:claimInfoオブジェクトの識別番号を示しており、これを使用してアーカイブ済みクレームを取得できる