API Documentation - Version 0.3.0

Update claim

Updates a claim.

The claim is updated and kept status draft . The claim is not yet reported to Carl Schröter and no processing takes place. The claim can be updated any number of times.


  PUT /api/claims/:id

Parameter

All parameters must be passed under the key claim , expect id which is part of the URL.

Name	Type	Required	Description	Example
causer	address	Yes	The address of the causer. See Addresses	{ id: "same_as_client" }
claim_number_broker	string	No	A reference number of the broker
claim_number_insured	string	No	A reference number of the insured
claimant	address	Yes	The address of the claimant. See Addresses	{ id: "same_as_client" }
clean_receipt	boolean	No	Delivery receipt with depreciation	false
client	address	Yes	The client address. See Addresses
damage_amount_amount	amount	Yes	The amount of damage	1234.56
damage_amount_is_estimated	boolean	Yes	Whether the amount is estimated or according to proof.	false
damage_course_of_events	text	No	Detailed description of how the damage occurred. Maximum of 1000 characters.	The story ...
damage_kind	string	Yes	See Damage kinds for valid values	fire_explosion
damage_kind_other	string	Yes, if damage_kind is other	Required in case damage_kind is other
damage_location	text	No	The location of the damage.	In the kitchen
damage_visitable	address	Yes	The address where the damage is visitable. See Addresses	{ id: "same_as_client" }
damaged_items	text	No	Detailed description of what is damaged.	Ming Vase
damaged_on	date	Yes	Date of damage	2024-10-05
goods_kind	string	Yes	Goods description	Vase
goods_loaded_by	string	Yes	By whom were the goods loaded. One of sender, driver, sender_and_driver	sender
goods_quantity	string	Yes	Quantity of goods	eine
goods_reloaded	boolean	Yes	Whether the goods were reloaded or not	false
goods_unloaded_by	string	Yes	By whom were the goods unloaded. One of sender, driver, sender_and_driver	driver
insurance_certificate_number	string	No	Only for claim of type goods
policy_id	id	Yes	The policy ID (policy number)	W1230042
reported_on	date	Yes	The date the claims was reported on.	2024-05-20
transport_delivered_on	date	Yes	Date of transport ended	2024-10-04
transport_means	string	No	See Means of transport for valid values	truck
transport_route_from	string	No	Location the transport started	Hamburg
transport_route_to	string	No	Location the transport ended	Berlin
transport_started_on	date	Yes	Date of transport start	2024-10-03

Example of request:


  curl -s -X PUT -H "CS-API-KEY: <your key>" -H "Content-Type: application/json" -d '{"claim":{ ... }}' https://api-staging.claims-online.de/api/claims/YHP17T

See Create claim for submitted data.

Example of response:

See Create claim