The operation new in case of a task will create a new task for a third party. Examples of tasks are inspection, valuation or repair of damage.
The entityType assignment
is always used in case of operation new.
How to use variants
This function is used to outsource a new task to a third party. The request contains essential and relevant information with regard to the party, policy and/or claim. It is recorded with AFD attributes, and complies with the AFD structures for party, policy and claim (see also chapter AFD structures).
A positive response to the operation new contains the AFD structure of the request as reference, with the result of the transaction (process.statusType).The requested information that was collected during the transaction, is also added to the output.
If a negative response is generated, that means the request is technically incorrect, it follows the general rules as described in the Error section of the HTTP status codes and error handling chapter.
Variants
The variant enables a differentiation in requirements to suit the specific situations (listed below), and for each variant, to which AFD structure it applies.
Variant | Description | task structure |
<default> | Standard request to perform a task | Yes |
appraisal | Establish the value of a (potentially) insured object | Yes |
lossAdjustment | Determine recovery/repair or replacement cost of an insured object | Yes |
repair | Repair or partially replace a (damaged) insured object | Yes |
repatriation | Transport of a person, goods or vehicle back to the place of residence of the insured | Yes |
riskAssessment | Evaluate risk exposure of a (potentially) insured person or object | Yes |
salvage | Salvage a damaged insured object | Yes |
- <default> – Standard request for a question, complaint or to perform a task
-
This variant can be used in case of a generic request for a question, complaint or to perform a task/
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks POST { uri } /tasks/new taskStructure taskStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. task refKey O Unique reference key assigned to an entity. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
- appraisal – Establish the value of a (potentially) insured object
-
This variant is used in case of appraisal of objects. This is not limited to appraisal in case of claim registration.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks POST { uri } /tasks/appraisal taskStructure taskStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.task refKey O Unique reference key assigned to an entity. task appraisalType I/O Coded indication of the type of the appraisal. task objectRef I/O Unique referral to the refKey of one or more object entities. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
- lossAdjustment – Determine recovery/repair or replacement cost of an insured object
-
This variant is used to determine the costs of repair or replacement following a claim.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks POST { uri } /tasks/loss-adjustment taskStructure taskStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.task refKey O Unique reference key assigned to an entity. task claimRef I/O Unique referral to the refkey of one or more claim entities. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
- repair – Repair or partially replace a (damaged) insured object
-
This variant is used to issue an order to repair an insured object following a claim.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks POST { uri } /tasks/repair taskStructure taskStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.task refKey O Unique reference key assigned to an entity. task claimRef I/O Unique referral to the refkey of one or more claim entities. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
- repatriation – Transport of a person, goods or vehicles back to the place of residence of the insured
-
This variant is used in case of retrieval of persons, goods and/or vehicles following a claim.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks POST { uri } /tasks/repatriation taskStructure taskStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.task refKey O Unique reference key assigned to an entity. task claimRef I/O Unique referral to the refkey of one or more claim entities. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
- riskAssessment – Evaluate risk exposure of a (potentially) insured person or object
-
This variant is used to assign a task to perform a risk analysis on (potentially) insured persons or objects.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks POST { uri } /tasks/risk-assessment taskStructure taskStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.task refKey O Unique reference key assigned to an entity. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
- salvage – Salvage a damaged insured object.
-
All actions that should limit the damage after a calamity, such as rescuing goods in the event of water damage or fire.
Endpoint definition
Method Endpoint Request Query
parameter(s)Response Remarks POST { uri } /tasks/salvage taskStructure taskStructure
Mandatory input and/or output (I/O) attributes
Entity Attribute I/O Remarks commonFunctional dataCatalogVersion I/O Version of the data catalog on which the message is based. commonFunctional functionVariant I/O The function variant is used to determine the additional set of required and optional input and output data. commonFunctional afdDefinitionName I/O Name of the AFD-definition. commonFunctional afdDefinitionVersion I/O Version of the AFD-definition. process statusType O The status of the process (codelist ADNSTS
) within theentityType
transaction.task refKey O Unique reference key assigned to an entity. task claimRef I/O Unique referral to the refkey of one or more claim entities. Note: since the attribute “entityType” is mandatory for all used structures, it is not mentioned in this table for clarity reasons.
Post your comment on this topic.