Introduction

WARNING

The Portal API is still in it's early stages and will likely have breaking changes in the near future.

The Vector Engineering Portal api allows individuals or organizations to intagrate with Vector Engineering to do things like submit projects using data from your own system.

The OpenAPI spec can be found at https://api.vectorse.com/openapi and the auto-generated API reference can be found here.

Feedback

We'd love to hear from you! If you have any questions, found a bug, or you think that there's a missing feature, send an email to api@vectorse.com.

Overview

Models

Currently, there are three types of resources this API focuses on:

name	description
Projects	Individual engineering projects that you submitted to Vector.
Members	Vector Portal users that are a part of your firm/organization.
Requests	Project discussions between your team and ours. A project can have zero or more requests linked to it.

The API models for these resources can be found here.

There's a base model (e.g. Project) and then there's models that are specific to an operation (e.g. ProjectCreate is used for the request body when creating a project). The models are used to define what data the API expects to recieve, and the data that it returns.

Pagination

Paginated results returns a the following fields:

name	description
page	The requested page number.
pageSize	The number of items returned.
total	The total number of results for the given query.
items	An array containing the results of the request.

Example

List of projects:

{
  "page": 1,
  "pageSize": 1,
  "total": 100,
  "items": [
    {
      "number": "U0001.0215.241",
      "name": "Residential Solar Example",
      "status": "active",
      "createDate": "2024-02-20T22:56:53.070Z",
      "estimatedCompletionDate": null,
      "completionDate": null,
      "type": "31",
      "typeName": "Solar - Residential",
      "disciplines": ["ST"],
      "jobId": "custom-unique-identifier-423951",
      "ahj": "Salt Lake County",
      "instructions": null,
      "address1": "651 W Galena Park Cir",
      "address2": "101",
      "address3": null,
      "city": "Draper",
      "state": "UT",
      "zip": "84020",
      "county": "Salt Lake County",
      "country": "US",
      "latitude": 0,
      "longitude": 0
    }
  ]
}