watercrafts

Download schema

create_watercraft

POST

/api/v2/watercrafts/create_watercraft

create_watercraft

create_watercraft › Request Body

Request Schema for /api/v2/watercrafts/create_watercraft

request-create_watercraft

object · required

Watercraft definition schema

skip_rules

boolean

Whether to skip business rules validation

Default: false

create_watercraft › Responses

200

Response Schema for /api/v2/watercrafts/create_watercraft

response-create_watercraft

watercraft-def · required

Watercraft definition schema

object[] · required

Any business rules that failed during creation

warnings

string[] · required

Any warnings generated during creation

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/watercrafts/create_watercraft

curl --request POST \
  --url /api/v2/watercrafts/create_watercraft \
  --header 'Content-Type: application/json' \
  --data '
{
  "watercraft": {
    "id": "id",
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "watercraft_hull_id": "watercraft_hull_id",
    "watercraft_type": "watercraft_type",
    "watercraft_type_label": "watercraft_type_label",
    "watercraft_year": 1900,
    "watercraft_make": "watercraft_make",
    "watercraft_model": "watercraft_model",
    "watercraft_length": 0,
    "watercraft_horsepower": "watercraft_horsepower",
    "watercraft_number": 0,
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "primary_operator_id": "primary_operator_id",
    "secondary_operator_id": "secondary_operator_id",
    "custom_fields": [
      {}
    ],
    "deleted": false,
    "included_in_policy": true,
    "previous_id": "previous_id",
    "added_from_template": true
  },
  "skip_rules": false
}
'

Example Request Body

{
  "watercraft": {
    "id": "id",
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "watercraft_hull_id": "watercraft_hull_id",
    "watercraft_type": "watercraft_type",
    "watercraft_type_label": "watercraft_type_label",
    "watercraft_year": 1900,
    "watercraft_make": "watercraft_make",
    "watercraft_model": "watercraft_model",
    "watercraft_length": 0,
    "watercraft_horsepower": "watercraft_horsepower",
    "watercraft_number": 0,
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "primary_operator_id": "primary_operator_id",
    "secondary_operator_id": "secondary_operator_id",
    "custom_fields": [
      {}
    ],
    "deleted": false,
    "included_in_policy": true,
    "previous_id": "previous_id",
    "added_from_template": true
  },
  "skip_rules": false
}

json

Example Responses

{
  "data": {
    "id": "id",
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "watercraft_hull_id": "watercraft_hull_id",
    "watercraft_type": "watercraft_type",
    "watercraft_type_label": "watercraft_type_label",
    "watercraft_year": 1900,
    "watercraft_make": "watercraft_make",
    "watercraft_model": "watercraft_model",
    "watercraft_length": 0,
    "watercraft_horsepower": "watercraft_horsepower",
    "watercraft_number": 0,
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "primary_operator_id": "primary_operator_id",
    "secondary_operator_id": "secondary_operator_id",
    "custom_fields": [
      {}
    ],
    "deleted": false,
    "included_in_policy": true,
    "previous_id": "previous_id",
    "added_from_template": true
  },
  "failed_rules": [
    {}
  ],
  "warnings": [
    "string"
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

delete_watercraft

POST

/api/v2/watercrafts/delete_watercraft

delete_watercraft

delete_watercraft › Request Body

Request Schema for /api/v2/watercrafts/delete_watercraft

request-delete_watercraft

id

string · required

The ID of the watercraft to delete

delete_watercraft › Responses

200

Response Schema for /api/v2/watercrafts/delete_watercraft

response-delete_watercraft

object · required

success

boolean · required

Indicates if the request was successful

required

get_watercraft

POST

/api/v2/watercrafts/get_watercraft

get_watercraft

get_watercraft › Request Body

Request Schema for /api/v2/watercrafts/get_watercraft

request-get_watercraft

id

string · required

The ID of the watercraft to retrieve

get_watercraft › Responses

200

Response Schema for /api/v2/watercrafts/get_watercraft

response-get_watercraft

watercraft-def · required

Watercraft definition schema

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/watercrafts/get_watercraft

curl --request POST \
  --url /api/v2/watercrafts/get_watercraft \
  --header 'Content-Type: application/json' \
  --data '{
  "id": "id"
}'

Example Request Body

{
  "id": "id"
}

json

Example Responses

{
  "data": {
    "id": "id",
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "watercraft_hull_id": "watercraft_hull_id",
    "watercraft_type": "watercraft_type",
    "watercraft_type_label": "watercraft_type_label",
    "watercraft_year": 1900,
    "watercraft_make": "watercraft_make",
    "watercraft_model": "watercraft_model",
    "watercraft_length": 0,
    "watercraft_horsepower": "watercraft_horsepower",
    "watercraft_number": 0,
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "primary_operator_id": "primary_operator_id",
    "secondary_operator_id": "secondary_operator_id",
    "custom_fields": [
      {}
    ],
    "deleted": false,
    "included_in_policy": true,
    "previous_id": "previous_id",
    "added_from_template": true
  },
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

list_custom_fields_types

POST

/api/v2/watercrafts/list_custom_fields_types

list_custom_fields_types

list_custom_fields_types › Request Body

Request Schema for /api/v2/watercrafts/list_custom_fields_types

request-list_custom_fields_types

quote_id

string · uuid · required

The ID of the quote to get custom field types for

list_custom_fields_types › Responses

200

Response Schema for /api/v2/watercrafts/list_custom_fields_types

response-list_custom_fields_types

object[] · required

success

boolean · required

Indicates if the request was successful

required

list_watercrafts_for_quote

POST

/api/v2/watercrafts/list_watercrafts_for_quote

list_watercrafts_for_quote

list_watercrafts_for_quote › Request Body

Request Schema for /api/v2/watercrafts/list_watercrafts_for_quote

request-list_watercrafts_for_quote

quote_id

string · uuid · required

The ID of the quote to list watercrafts for

list_watercrafts_for_quote › Responses

200

Response Schema for /api/v2/watercrafts/list_watercrafts_for_quote

response-list_watercrafts_for_quote

watercraft-def[] · required

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/watercrafts/list_watercrafts_for_quote

curl --request POST \
  --url /api/v2/watercrafts/list_watercrafts_for_quote \
  --header 'Content-Type: application/json' \
  --data '
{
  "quote_id": "00000000-0000-0000-0000-000000000000"
}
'

Example Request Body

{
  "quote_id": "00000000-0000-0000-0000-000000000000"
}

json

Example Responses

{
  "data": [
    {
      "id": "id",
      "address_city": "address_city",
      "address_county": "address_county",
      "address_line1": "address_line1",
      "address_line2": "address_line2",
      "address_state": "address_state",
      "address_zip": "address_zip",
      "watercraft_hull_id": "watercraft_hull_id",
      "watercraft_type": "watercraft_type",
      "watercraft_type_label": "watercraft_type_label",
      "watercraft_year": 1900,
      "watercraft_make": "watercraft_make",
      "watercraft_model": "watercraft_model",
      "watercraft_length": 0,
      "watercraft_horsepower": "watercraft_horsepower",
      "watercraft_number": 0,
      "quote_id": "00000000-0000-0000-0000-000000000000",
      "primary_operator_id": "primary_operator_id",
      "secondary_operator_id": "secondary_operator_id",
      "custom_fields": [
        {}
      ],
      "deleted": false,
      "included_in_policy": true,
      "previous_id": "previous_id",
      "added_from_template": true
    }
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

update_watercraft

POST

/api/v2/watercrafts/update_watercraft

update_watercraft

update_watercraft › Request Body

Request Schema for /api/v2/watercrafts/update_watercraft

request-update_watercraft

object · required

Watercraft definition schema

skip_rules

boolean

Whether to skip business rules validation

Default: false

update_watercraft › Responses

200

Response Schema for /api/v2/watercrafts/update_watercraft

response-update_watercraft

watercraft-def · required

Watercraft definition schema

object[] · required

Any business rules that failed during update

warnings

string[] · required

Any warnings generated during update

success

boolean · required

Indicates if the request was successful

required

POST/api/v2/watercrafts/update_watercraft

curl --request POST \
  --url /api/v2/watercrafts/update_watercraft \
  --header 'Content-Type: application/json' \
  --data '
{
  "watercraft": {
    "id": "id",
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "watercraft_hull_id": "watercraft_hull_id",
    "watercraft_type": "watercraft_type",
    "watercraft_type_label": "watercraft_type_label",
    "watercraft_year": 1900,
    "watercraft_make": "watercraft_make",
    "watercraft_model": "watercraft_model",
    "watercraft_length": 0,
    "watercraft_horsepower": "watercraft_horsepower",
    "watercraft_number": 0,
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "primary_operator_id": "primary_operator_id",
    "secondary_operator_id": "secondary_operator_id",
    "custom_fields": [
      {}
    ],
    "deleted": false,
    "included_in_policy": true,
    "previous_id": "previous_id",
    "added_from_template": true
  },
  "skip_rules": false
}
'

Example Request Body

{
  "watercraft": {
    "id": "id",
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "watercraft_hull_id": "watercraft_hull_id",
    "watercraft_type": "watercraft_type",
    "watercraft_type_label": "watercraft_type_label",
    "watercraft_year": 1900,
    "watercraft_make": "watercraft_make",
    "watercraft_model": "watercraft_model",
    "watercraft_length": 0,
    "watercraft_horsepower": "watercraft_horsepower",
    "watercraft_number": 0,
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "primary_operator_id": "primary_operator_id",
    "secondary_operator_id": "secondary_operator_id",
    "custom_fields": [
      {}
    ],
    "deleted": false,
    "included_in_policy": true,
    "previous_id": "previous_id",
    "added_from_template": true
  },
  "skip_rules": false
}

json

Example Responses

{
  "data": {
    "id": "id",
    "address_city": "address_city",
    "address_county": "address_county",
    "address_line1": "address_line1",
    "address_line2": "address_line2",
    "address_state": "address_state",
    "address_zip": "address_zip",
    "watercraft_hull_id": "watercraft_hull_id",
    "watercraft_type": "watercraft_type",
    "watercraft_type_label": "watercraft_type_label",
    "watercraft_year": 1900,
    "watercraft_make": "watercraft_make",
    "watercraft_model": "watercraft_model",
    "watercraft_length": 0,
    "watercraft_horsepower": "watercraft_horsepower",
    "watercraft_number": 0,
    "quote_id": "00000000-0000-0000-0000-000000000000",
    "primary_operator_id": "primary_operator_id",
    "secondary_operator_id": "secondary_operator_id",
    "custom_fields": [
      {}
    ],
    "deleted": false,
    "included_in_policy": true,
    "previous_id": "previous_id",
    "added_from_template": true
  },
  "failed_rules": [
    {}
  ],
  "warnings": [
    "string"
  ],
  "success": true,
  "messages": [
    "string"
  ]
}

json

application/json

violations workflows