Options | Documentation

curl https://api-staging.nibtravelinsurance.com/products/v1/nibau/plans/1000000/options \
     -H "Authorization: Bearer <token>"

{
  "expirySeconds": 86400,
  "planId": 280,
  "adventureActivitiesOption": {
    "optionId": 113,
    "optionType": "ADVENTUREACTIVITY",
    "name": "Adventure Activities",
    "effectiveFromDate": "1970-01-01T00:00:00Z",
    "effectiveToDate": "1970-01-01T00:00:00Z",
    "displayOrder": 20,
    "adventureActivities": [
      {
        "adventureActivityId": 14695,
        "name": "Abseiling",
        "riskLevel": 3,
        "hasCover": true
      },
      {
        "adventureActivityId": 14739,
        "name": "Acrobatics",
        "riskLevel": 1,
        "hasCover": true
      }
    ],
    "availableTranslations": {
      "key": "value"
    }
  },
  "basicOptions": [
    {
      "optionId": 1000000,
      "optionType": "optionType",
      "name": "name",
      "effectiveFromDate": "effectiveFromDate",
      "effectiveToDate": "effectiveToDate",
      "displayOrder": 1,
      "optInValues": [
        {}
      ]
    }
  ],
  "specifiedItemsOption": {
    "optionId": 114,
    "optionType": "SPECITEMS",
    "name": "High Value Items - Standard",
    "effectiveFromDate": "1970-01-01T00:00:00Z",
    "effectiveToDate": "1970-01-01T00:00:00Z",
    "displayOrder": 10,
    "maxSpecifiedItems": 20,
    "itemMaxValue": 1.1,
    "totalMaxValuePerPolicy": 12000,
    "totalMaxValuePerPolicyHolder": 6000,
    "appliesToDependents": false,
    "specifiedItemTypes": [
      {
        "specifiedItemTypeId": 142,
        "specifiedItemTypeCode": "Sports",
        "name": "Sports Gear",
        "itemMaxValue": 3000,
        "infoText": "You may specify a single item or related set of items (e.g skis + bindings = 1 item)\r\nNo cover for bicycles, bicycle accessories; any equipment over three years old; watercraft (unless it’s a surfboard); firearms; commercial items or business equipment.\r\nA $100 excess applies per event."
      },
      {
        "specifiedItemTypeId": 143,
        "specifiedItemTypeCode": "Tech",
        "name": "Tech & Cameras",
        "itemMaxValue": 3000,
        "infoText": "You may specify a single item or related set of items (e.g Camera + lenses + camera accessories = 1 item)\r\nNo cover for commercial items or business equipment.\r\nA $100 excess applies per event."
      },
      {
        "specifiedItemTypeId": 144,
        "specifiedItemTypeCode": "Personal",
        "name": "Personal Items",
        "itemMaxValue": 3000,
        "infoText": "You may specify a single item or related set of items (e.g pair of shoes = 1 item)\r\nNote: Jewellery cannot be specified.\r\nNo cover for glasses, sunglasses, contact lenses, musical instruments, dentures, hearing aids,  prostheses, antiques, loose precious stones, animals, perishables, commercial items or business equipment.\r\nA $100 excess applies per event."
      }
    ],
    "availableTranslations": {
      "key": "value"
    }
  },
  "cancellationOption": {
    "optionId": 1000000,
    "optionType": "optionType",
    "name": "name",
    "effectiveFromDate": "effectiveFromDate",
    "effectiveToDate": "effectiveToDate",
    "displayOrder": 1,
    "preCoverCancellationCoverLimitPerPolicyHolder": 1.1,
    "preCoverCancellationCoverLimitPerPolicy": 1.1,
    "maxTripValuePerTraveller": 1.1,
    "cancellationCoverLimits": [
      {}
    ]
  }
}

Returns the available Options for a plan

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

brandCodeenumRequired

Brand code

Allowed values:

planIdlongRequiredDefaults to 0

Query parameters

langstringOptional

Response

Success

expirySecondsinteger

planIdlongDefaults to 0

adventureActivitiesOptionobject

basicOptionslist of objects

specifiedItemsOptionobject

cancellationOptionobject