/projects

Projects API is for reporting on pricing project states and to aid in building custom quote flows

Retrieve all projects

Return all pricing project versions

GEThttps://api.llow.io/sw/projects

Query parameters

Response

200

/sw/projects response

Body

application/json

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

company_referencestring

Company reference. It is a UUID.

Example: "86c575d2-b6b9-44ed-9c75-8d705b987ec1"

namestring

Pricing project name.

Example: "Monthly motor insurance product"

descriptionstring

Pricing project description.

Example: "Monthly motor insurance product for the UK market"

summarystring

A html formatted change log of a project version.

Example: "<p>Example change log of version</p>"

versioninteger

Pricing project version which iterates by +1 every time the project is published.

Example: 1

statusstring

Pricing project published status. It can be in draft, approved, published or subsequently unpublished

Example: "draft"

sizenumber

Pricing project size in MBs.

Example: 8.6

disabledboolean

Whether the pricing project is disabled. If disabled then the project can not be edited and will not be available to price against.

Example: false

approved_atstring

The time that it was approved

Example: "2021-04-22T14:29:22.000Z"

published_atstring

The time it was (or will be) published

Example: "2021-04-22T14:29:22.000Z"

updated_atstring

The time that it was last updated

Example: "2021-04-22T14:29:22.000Z"

created_atstring

The time of creation

Example: "2021-03-22T14:29:22.000Z"

versionsarray of object

All previous versions of a project.

Request

JavaScriptCurlPython

const response = await fetch('https://api.llow.io/sw/projects', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "name": "Monthly motor insurance product",
  "description": "Monthly motor insurance product for the UK market",
  "summary": "<p>Example change log of version</p>",
  "version": 1,
  "status": "draft",
  "size": 8.6,
  "disabled": false,
  "approved_at": "2021-04-22T14:29:22.000Z",
  "published_at": "2021-04-22T14:29:22.000Z",
  "updated_at": "2021-04-22T14:29:22.000Z",
  "created_at": "2021-03-22T14:29:22.000Z",
  "versions": []
}

This will retrieve all projects within your account. It will show the latest published version along with other useful project details.

Retrieve a specific project

Return the latest pricing project

GEThttps://api.llow.io/sw/projects/{project_reference}

Path parameters

project_reference*string

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

Query parameters

Response

200

/sw/projects/{project_reference} response

Body

application/json

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

company_referencestring

Company reference. It is a UUID.

Example: "86c575d2-b6b9-44ed-9c75-8d705b987ec1"

namestring

Pricing project name.

Example: "Monthly motor insurance product"

descriptionstring

Pricing project description.

Example: "Monthly motor insurance product for the UK market"

summarystring

A html formatted change log of a project version.

Example: "<p>Example change log of version</p>"

versioninteger

Pricing project version which iterates by +1 every time the project is published.

Example: 1

statusstring

Pricing project published status. It can be in draft, approved, published or subsequently unpublished

Example: "draft"

sizenumber

Pricing project size in MBs.

Example: 8.6

disabledboolean

Whether the pricing project is disabled. If disabled then the project can not be edited and will not be available to price against.

Example: false

approved_atstring

The time that it was approved

Example: "2021-04-22T14:29:22.000Z"

published_atstring

The time it was (or will be) published

Example: "2021-04-22T14:29:22.000Z"

updated_atstring

The time that it was last updated

Example: "2021-04-22T14:29:22.000Z"

created_atstring

The time of creation

Example: "2021-03-22T14:29:22.000Z"

versionsarray of object

All previous versions of a project.

Request

JavaScriptCurlPython

const response = await fetch('https://api.llow.io/sw/projects/{project_reference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "name": "Monthly motor insurance product",
  "description": "Monthly motor insurance product for the UK market",
  "summary": "<p>Example change log of version</p>",
  "version": 1,
  "status": "draft",
  "size": 8.6,
  "disabled": false,
  "approved_at": "2021-04-22T14:29:22.000Z",
  "published_at": "2021-04-22T14:29:22.000Z",
  "updated_at": "2021-04-22T14:29:22.000Z",
  "created_at": "2021-03-22T14:29:22.000Z",
  "versions": []
}

This will show a specific project with the latest published version, all versions to date and their status.

Each project has a unique project_reference and each version has a unique version_reference.

Retrieve all project versions

Return all pricing project versions

GEThttps://api.llow.io/sw/projects/versions

Query parameters

Response

200

/sw/projects/versions response

Body

application/json

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

company_referencestring

Company reference. It is a UUID.

Example: "86c575d2-b6b9-44ed-9c75-8d705b987ec1"

namestring

Pricing project name.

Example: "Monthly motor insurance product"

descriptionstring

Pricing project description.

Example: "Monthly motor insurance product for the UK market"

summarystring

A html formatted change log of a project version.

Example: "<p>Example change log of version</p>"

versioninteger

Pricing project version which iterates by +1 every time the project is published.

Example: 1

statusstring

Pricing project published status. It can be in draft, approved, published or subsequently unpublished

Example: "draft"

sizenumber

Pricing project size in MBs.

Example: 8.6

disabledboolean

Whether the pricing project is disabled. If disabled then the project can not be edited and will not be available to price against.

Example: false

approved_atstring

The time that it was approved

Example: "2021-04-22T14:29:22.000Z"

published_atstring

The time it was (or will be) published

Example: "2021-04-22T14:29:22.000Z"

updated_atstring

The time that it was last updated

Example: "2021-04-22T14:29:22.000Z"

created_atstring

The time of creation

Example: "2021-03-22T14:29:22.000Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.llow.io/sw/projects/versions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "company_reference": "86c575d2-b6b9-44ed-9c75-8d705b987ec1",
  "name": "Monthly motor insurance product",
  "description": "Monthly motor insurance product for the UK market",
  "summary": "<p>Example change log of version</p>",
  "version": 1,
  "status": "draft",
  "size": 8.6,
  "disabled": false,
  "approved_at": "2021-04-22T14:29:22.000Z",
  "published_at": "2021-04-22T14:29:22.000Z",
  "updated_at": "2021-04-22T14:29:22.000Z",
  "created_at": "2021-03-22T14:29:22.000Z"
}

Project versions can be returned in bulk or filtered via the summary change log (using ?summary)

https://api.llow.io/sw/projects/versions?summary=search%20term

or via project_reference

https://api.llow.io/sw/projects/versions?project_reference=56c575d2-b6b9-44ed-9c75-5d705b987ec1

Help building your own quote flows

This is a public API endpoint. You can hit this endpoint for client-side code by just providing client_id_key in the header. View authentication to find out more. Public APIs have /public/ within the endpoint url.

Returns public project details to build custom form

GEThttps://api.llow.io/sw/public/projects/{project_reference}

Path parameters

project_reference*string

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

Response

200

/sw/public/projects/{project_reference} response

Body

application/json

version_referencestring

Project version reference. It is a UUID.

Example: "46c575d2-b6b9-44ed-9c75-5d705b987ec1"

project_referencestring

Project reference. It is a UUID.

Example: "56c575d2-b6b9-44ed-9c75-5d705b987ec1"

versioninteger

Pricing project version which iterates by +1 every time the project is published.

Example: 1

updated_atstring

The time that it was last updated

Example: "2021-04-22T14:29:22.000Z"

inputsobject

The inputs of a project to assist in building a custom quote form.

listsobject

The inputs of a project to assist in building a custom quote form.

Request

JavaScriptCurlPython

const response = await fetch('https://api.llow.io/sw/public/projects/{project_reference}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "version_reference": "46c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "project_reference": "56c575d2-b6b9-44ed-9c75-5d705b987ec1",
  "version": 1,
  "updated_at": "2021-04-22T14:29:22.000Z",
  "inputs": {
    "bike_type": {
      "type": "string",
      "label": "Your bike type",
      "def": "Road"
    }
  },
  "lists": {
    "bike_type": {
      "type": "string",
      "data": [
        "Road",
        "Mountain",
        "BMX"
      ]
    }
  }
}

The public project endpoint will return all the input parameters needed for a Swallow pricing project and all the lists of data options (generated by factor table data). This allows you to build custom and validated custom quote flows.

The quote flows can be programmatic (aggregator integrations) or via custom build user interfaces (within an app or website).