API Documentation - Version 0.3.0

Get policy

Returns a policy.


  GET /api/policies/:id

Parameter

Name	Type	Required	Description
id	ID	Yes	The ID of the policy (same as policy number), e.g. W1230042

Example of request:


  curl -s -H "CS-API-KEY: <your key>" -H "Content-Type: application/json" https://api-staging.claims-online.de/api/policies/W1230042

Example of response:


{
  "data":{
    "id":"W1230042",
    "type":"policies",
    "attributes":{
      "policy_number":"W1230042",
      "begin_period":"2024-01-01",
      "end_period":"2024-12-31",
      "begin_usage_period":"2023-12-15",
      "end_usage_period":"2025-01-31",
      "in_usage_period":true,
      "currency":"EUR",
      "contract_division":"goods"
    },
    "links":{
      "self":"https://api-staging.claims-online.de/api/policies/W1230042"
    }
  },
  "links":{
    "self":"https://api-staging.claims-online.de/api/policies/W1230042"
  }
}