{"info":{"_postman_id":"e26e6bf9-8993-4b72-9d4d-e8d0bbec451f","name":"PZSE API External Documentation","description":"

PZSE Portal API Reference

Introduction

The PZSE Portal API for PZSE Portal 2.0 empowers our vetted partners with the ability to build custom applications that interact with the PZSE Portal 2.0 online tool. The PZSE Portal API provides EPC’s with broad coverage of the PZSE Portal 2.0 solution, including access to Project Overviews, Project Status, and transaction related functions.

Permission to use the PZSE Portal API and acquiring an API key is only for approved and vetted PZSE partners and clients. Use of the PZSE Portal API is under the assumption that PZSE clients will only use the API to submit Residential Roof Mount PV Systems projects. PZSE Portal API pricing is based off of the PZSE Portal 2.0 SaaS agreement. If you need structural engineering assistance for ground mount, ballasted, or EV charging station installations, please email projects@pzse.com.

The PZSE Portal API is only supporting project types for structural engineering at this time, this would include IEBC letter and Full Structural Calculations. The third party services for electrical stamps and electrical fault study are not available via the PZSE Portal API.

The reference documentation does not cover all scenarios or project types. Parameters, example
requests, and responses are provided for general understanding. For advanced assistance, please email portal@pzse.com.

Express Training

Please refer to our PZSE Express Training to learn more about our express projects!

APIs

1. Auth API

· Post Login

· Post Logout

2. Projects

· Get Projects

· Get Project

· Post Create Project

· Post Project Restamp FS

· Post Project Restamp IEBC Express

· Post Project Post-Install

· Post Project Post-Install Restamp

· Post Project Wetstamp

3. Project File Upload

· Post Structural Plans File Upload

· Post Pre-Install Photos File Upload

4. Project File Download

· Get Stamped Structural Plan File Download

· Get Stamped IEBC Letter File Download

· Get Stamped Electrical Plan File Download

· Get Stamped Structural Calcs File Download

· Get Structural Plans File Download

· Get Electrical Redlines File Download

· Get Redlines File Download

· Get Cert Letter File Download

· Get Misc Files Download
· Get Photos File Download

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"25479959","collectionId":"e26e6bf9-8993-4b72-9d4d-e8d0bbec451f","publishedId":"2s8ZDbVfni","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2025-06-10T14:36:39.000Z"},"item":[{"name":"Auth","item":[{"name":"Login","event":[{"listen":"prerequest","script":{"id":"cc82321b-5163-441e-90b8-387b4bcc716d","exec":[""],"type":"text/javascript"}},{"listen":"test","script":{"id":"6747a553-1ff9-4b4e-87a8-fb2b242a54cc","exec":["let ext = pm.response.json();\r","pm.environment.set(\"EXTERNAL_ACCESS_TOKEN\", ext.result.access_token);"],"type":"text/javascript"}}],"id":"422d542e-64bb-4e16-a169-13d09b58fe3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"account_id","value":"(Your Account ID)","type":"text"},{"key":"client_id","value":"(Your Client ID)","type":"text"},{"key":"client_secret","value":"(Your Client Secret)","type":"text"}]},"url":"{{BASE_URL}}/api/external/auth/login","description":"

POST /api/external/auth/login

account_id - ID of the account in accounts table.
\n
client_id - ID of the client in oauth_clients table linked to the account in accounts table.
\n
client_secret - Secret key of the client in oauth_clients table linked to the account in accounts table.
\n

\n","urlObject":{"path":["api","external","auth","login"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"03bb32f9-da2d-489b-9e35-fa9c63711b75","name":"Login Client Admin","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"account_id","value":"(Your Account ID)","type":"text"},{"key":"client_id","value":"(Your Client ID)","type":"text"},{"key":"client_secret","value":"(Your Client Secret)","type":"text"}]},"url":"{{BASE_URL}}/api/external/auth/login"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Successfully logged in.\",\n \"result\": {\n \"token_type\": \"Bearer\",\n \"expires_in\": 604800,\n \"access_token\": \"eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiJ9.eyJhdWQiOiI5ODI3ZjQ5OC0xNDIxLTQ1YWEtYmY1ZS0wZjMyZmUyNDc3MWMiLCJqdGkiOiI4YmZmMGJiOWIyOTViZDUzNzI1YjM4NjFiMzBjMDVhZmVmZjlmNjA2ZWRmODM4YjNlNjk0YzBhZWM2MWE5YTg2NjlkMTg3NjBjMDI4MTc2OSIsImlhdCI6MTY3NDU0Nzg4NC41NzU4OTgsIm5iZiI6MTY3NDU0Nzg4NC41NzU5MDEsImV4cCI6MTY3NTE1MjY4NC41NTI5NDksInN1YiI6IjYiLCJzY29wZXMiOltdfQ.Nre665Jh7vn2mg82q13KnTIEJuF1vcQJ3YwnBA0WSfUcGczOB7JjSqwdq80ux7vWMLqnHK6tyhnpzkz4OBPDgh-fUC0bR4T4uDB43ndUj99yUkM-DzJ0_y4qACR9cauwPXU9PjiPE0zTJ6Zsg4aizi-Y3QqOMGozGSP7dXjccpioiBS9aobjNiQN4fBAQ-Cl4qP7t3BMaDZPxNzSx6kmSP8JKGSEXJFqo0we9dSvoI_QzSO2F2fen4czHJgDVkEthg_JoyTnOau6OtpbOUqmLdMTqTf6sCc2W_vx8OP0DuaBqWTcmzFmXo4wB-q_3ejZzn4NfCrhvp7w3R7z6jUcFo376E40VHu1vq-GTlAqMiCjM9x--uKJv5Zahuo5wOk05COBoA_Nvo4cHJC-HFzN9QpZpXJjOl75rIvk8JqjPscdZrXbwxTpev6w6ctZF38omIfUiIdym03ipzfjWU2WX67UPCOkpQfnme2z_hcCGnGgREyrxLtgjalcxoVfykqOHWoshDHepwW9lZpGNmAuD69n2RhS5S-DpeJDzbv1zZOWK2WodLVKSUuBsm2vfwzOLR6VTfiojfHYyxZe4OrCVM7fTQbjUVTin9yKSRqA3JAAqgYW0NiZzzhCweNyuud_ik3tEPCZfl_xVEnjJK8TnTfVoEtjAnCAG-ir_mK4riGUAx0\",\n \"refresh_token\": \"def50200542fc1fc1efd69ce24d7e81aa2066b9c7d31b6b919799225e8546863412ea5f08f8f8a597c17c7a23c4e59bccb9a900df46f928fd56e49dbbdc850da5b65955da223b080a731c18260253ab70b8aa4c77af7ca2f575e359715a602a4ef46298f1cf3c2ac6d1dc5778f4694af5a81ffb240d32a5d77354d93e3e67f38e6ccce8fd1ee11cb1f80e20765b7f4d053bed5c939cd3724f428426d85ef6037c8e130f1d3e1eeb92fafb28a8be9bef2610563ca12682fd8d94089918e167c4ef8e2a6ca23b3b74qwdqwb6b6fceb3aef6b31d28d16be367201892db7e1329f49e6602e80fd4d2ec9abc81f8f0de58b2110f4ca17b5d7e7dafc200958a7fd31d4e89a8de64d8bbf815e1aa6d20f412959f327cc6ed10dba799f5224e8834ff8795dd3d855d6426b2b093c49f839af76f0b3ee97e866fc3c983ef4ae8af767a37d47d229d591bd91f55b64792b13c0a41eef115415f5fcc29398d23d0f5b1efcb26c801be65b7dee23091aca7db88918ae64eb88696c5ce9f17e90a455f11fcf9fd6b251d32102b\"\n }\n}"}],"_postman_id":"422d542e-64bb-4e16-a169-13d09b58fe3f"},{"name":"Logout","event":[{"listen":"prerequest","script":{"exec":[""],"type":"text/javascript","id":"7622cdbd-ffc7-40de-be50-c88b8952d4e4"}},{"listen":"test","script":{"exec":["let ext = pm.response.json();\r","pm.environment.set(\"EXTERNAL_ACCESS_TOKEN\", ext.result.access_token);"],"type":"text/javascript","id":"ba93512c-4771-4af8-964d-991cdc82aa59"}}],"id":"fb04d2e0-0c0c-4731-bbe7-2dd0d1ce2991","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"url":"{{BASE_URL}}/api/external/auth/logout","description":"

POST /api/external/auth/login

account_id - ID of the account in accounts table.
client_id - ID of the client in oauth_clients table linked to the account in accounts table.
client_secret - Secret key of the client in oauth_clients table linked to the account in accounts table.

\n","urlObject":{"path":["api","external","auth","logout"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"10902e58-2060-456d-9157-c084e87e269e","name":"Logout User","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"url":"{{BASE_URL}}/api/external/auth/logout"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Successfully logged out.\",\n \"result\": {}\n}"}],"_postman_id":"fb04d2e0-0c0c-4731-bbe7-2dd0d1ce2991"}],"id":"b8976691-9f0d-42ba-8a52-f16058ed35c3","description":"

Every PZSE Portal 2.0 API endpoint you access requires that you supply an access token in the header of your request to verify. Vetted and verified partners of PZSE with a Portal 2.0 API access token may use their PZSE Portal 2.0 Account ID, Secret, and Client ID provided by PZSE to create an API Token for use in their applications.

\n","_postman_id":"b8976691-9f0d-42ba-8a52-f16058ed35c3"},{"name":"Projects","item":[{"name":"Project","id":"680f7421-a09e-48b8-9fb0-c21a0e56debf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BASE_URL}}/api/external/projects/{{PROJECT_ID}}","description":"

GET /api/external/projects/{id}

{id} - ID of the project in projects table. This will correspond to the PZSE Portal 2.0 project number.

\n","urlObject":{"path":["api","external","projects","{{PROJECT_ID}}"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"14041623-6668-4d47-9459-ce2ac87cb65e","name":"Get Project","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[]},"url":"{{BASE_URL}}/api/external/projects/{{PROJECT_ID}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"OK.\",\n \"result\": {\n \"deltek_id\": \"2023-00715\",\n \"number\": \"P23-I240101QMH\",\n \"name\": \"PZSE Portal Test\",\n \"service\": \"IEBC Letter\",\n \"address\": \"913 Aurora Avenue, Aurora, IL\",\n \"project_status\": \"Forwarded To Engineer\",\n \"submitted_by\": \"John Doe\",\n \"submittal_date\": \"2023-01-24T01:50:27.000000Z\",\n \"status\": \"Active\"\n }\n}"}],"_postman_id":"680f7421-a09e-48b8-9fb0-c21a0e56debf"},{"name":"Projects","id":"424110b4-840d-42c4-87f8-2357893d02f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":"{{BASE_URL}}/api/external/projects?page=1&per_page=5&show_archived=true&term=TX","description":"

GET /api/external/projects

\n","urlObject":{"path":["api","external","projects"],"host":["{{BASE_URL}}"],"query":[{"description":{"content":"

Page Number

\n","type":"text/plain"},"key":"page","value":"1"},{"description":{"content":"

Items per page

\n","type":"text/plain"},"key":"per_page","value":"5"},{"description":{"content":"

Show archived projects

\n","type":"text/plain"},"key":"show_archived","value":"true"},{"description":{"content":"

Search Term. Can search using Project Name, Number, Creator Name, Address (Can search via individual part of address or search via full address by using comma-space (, ) as delimiter per part of address.

\n","type":"text/plain"},"key":"term","value":"TX"}],"variable":[]}},"response":[{"id":"7b8942b8-15b0-4dbf-b6ca-060493d3d15c","name":"Get Projects","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[]},"url":{"raw":"{{BASE_URL}}/api/external/projects?page=1&per_page=5&show_archived=true&term=TX","host":["{{BASE_URL}}"],"path":["api","external","projects"],"query":[{"key":"page","value":"1","description":"Page Number"},{"key":"per_page","value":"5","description":"Items per page"},{"key":"show_archived","value":"true","description":"Show archived projects"},{"key":"term","value":"TX","description":"Search Term. Can search using Project Name, Number, Creator Name, Address (Can search via individual part of address or search via full address by using comma-space (`, `) as delimiter per part of address."}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"data\": [\n {\n \"deltek_id\": \"2023-00715\",\n \"number\": \"P23-I240101QMH\",\n \"name\": \"PZSE Portal Test\",\n \"service\": \"IEBC Letter\",\n \"address\": \"913 Aurora Avenue, Aurora, IL\",\n \"project_status\": \"Forwarded To Engineer\",\n \"submitted_by\": \"John Doe\",\n \"submittal_date\": \"2023-01-24T01:50:27.000000Z\",\n \"status\": \"Active\"\n },\n {\n \"deltek_id\": \"2023-15452\",\n \"number\": \"P23-I190123OZS\",\n \"name\": \"PZSE Portal Test\",\n \"service\": \"IEBC Letter\",\n \"address\": \"913 Aurora Avenue, Aurora, IL\",\n \"project_status\": \"Forwarded To Engineer\",\n \"submitted_by\": \"John Doe\",\n \"submittal_date\": \"2023-01-19T23:42:57.000000Z\",\n \"status\": \"Active\"\n },\n {\n \"deltek_id\": \"2023-15451\",\n \"number\": \"P23-I190119RZU\",\n \"name\": \"Project Demo Testing\",\n \"service\": \"IEBC Letter with Stamped Plans\",\n \"address\": \"913 Aurora Avenue, Aurora, IL\",\n \"project_status\": \"Forwarded To Engineer\",\n \"submitted_by\": \"John Doe\",\n \"submittal_date\": \"2023-01-19T19:34:32.000000Z\",\n \"status\": \"Active\"\n },\n {\n \"deltek_id\": \"2023-15450\",\n \"number\": \"P23-I190117TXR\",\n \"name\": \"Project Demo Testing\",\n \"service\": \"IEBC Letter\",\n \"address\": \"913 Aurora Avenue, Aurora, IL\",\n \"project_status\": \"Completed\",\n \"submitted_by\": \"John Doe\",\n \"submittal_date\": \"2023-01-19T17:51:35.000000Z\",\n \"status\": \"Active\"\n },\n {\n \"deltek_id\": \"2023-15447\",\n \"number\": \"P23-I190117RPZ\",\n \"name\": \"Project Demo Testing\",\n \"service\": \"IEBC Letter\",\n \"address\": \"913 Aurora Avenue, Aurora, IL\",\n \"project_status\": \"Forwarded To Engineer\",\n \"submitted_by\": \"John Doe\",\n \"submittal_date\": \"2023-01-19T17:27:19.000000Z\",\n \"status\": \"Active\"\n }\n ],\n \"links\": {\n \"first\": \"https://api-training.pzse.com/api/external/projects?page=1\",\n \"last\": \"https://api-training.pzse.com/api/external/projects?page=3\",\n \"prev\": null,\n \"next\": \"https://api-training.pzse.com/api/external/projects?page=2\"\n },\n \"meta\": {\n \"current_page\": 1,\n \"from\": 1,\n \"last_page\": 3,\n \"links\": [\n {\n \"url\": null,\n \"label\": \"« Previous\",\n \"active\": false\n },\n {\n \"url\": \"https://api-training.pzse.com/api/external/projects?page=1\",\n \"label\": \"1\",\n \"active\": true\n },\n {\n \"url\": \"https://api-training.pzse.com/api/external/projects?page=2\",\n \"label\": \"2\",\n \"active\": false\n },\n {\n \"url\": \"https://api-training.pzse.com/api/external/projects?page=3\",\n \"label\": \"3\",\n \"active\": false\n },\n {\n \"url\": \"https://api-training.pzse.com/api/external/projects?page=2\",\n \"label\": \"Next »\",\n \"active\": false\n }\n ],\n \"path\": \"https://api-training.pzse.com/api/external/projects\",\n \"per_page\": \"5\",\n \"to\": 5,\n \"total\": 11\n }\n}"}],"_postman_id":"424110b4-840d-42c4-87f8-2357893d02f4"},{"name":"Create Project","id":"31e2e904-9d5d-41a0-b855-5d7ba712254a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"creator_email\": \"Your account email address\",\r\n \"name\": \"Your Project Name\",\r\n \"client_po\": \"Your Project Number\",\r\n \"description\": \"Your description of the project\",\r\n \"type\": \"iebc-letter\",\r\n \"add_ons\" : [\r\n {\r\n \"name\" : \"wet-stamp\",\r\n \"quantity\" : \"(Number of Wet stamp copies requested for shipping)\"\r\n }\r\n ],\r\n \"shipping_profile\" : {\r\n \"address_1\": \"Shipping Address\",\r\n \"address_2\": \"Shipping Address 2\",\r\n \"county\": \"Shipping County\",\r\n \"city\": \"Shipping City\",\r\n \"state\": \"Shipping State\",\r\n \"postal_code\": \"Shipping Postal Code\",\r\n \"first_name\" : \"Shipping Contact First Name\",\r\n \"last_name\" : \"Shipping Contact Last Name\",\r\n \"phone_number\" : \"Shipping Contact Phone Number\",\r\n \"email\" : \"Shipping Contact Email Address\",\r\n \"company_name\" : \"Recieving Company\"\r\n },\r\n \"address\": {\r\n \"address_1\": \"(Project Address)\",\r\n \"address_2\": \"(Project Address 2)\",\r\n \"county\": \"(Project County)\",\r\n \"city\": \"(Project City)\",\r\n \"state\": \"(Project State)\",\r\n \"postal_code\": \"(Project Postal Code)\",\r\n \"longitude\": \"(Project Coordinates - Longitude)\",\r\n \"latitude\": \"(Project Coordinates - Latitude)\"\r\n },\r\n \"project_meta\": {\r\n \"building_description\": \"(Building Description)\",\r\n \"surrounding_terrain\": \"(Surrounding Terrain)\",\r\n \"roof_material_type\": \"(Roof Material Type)\",\r\n \"roof_slope\": \"(Project Roof Slope)\",\r\n \"roof_type\" : \"(Project Roof Type)\",\r\n \"building_width\" : \"(Project Building Width in Feet)\",\r\n \"building_length\" : \"(Project Building Length in Feet)\",\r\n \"number_of_stories\" : \"(Project Building Number of Stories)\",\r\n \"number_of_panels\" : \"(Project Number of Panels)\"\r\n },\r\n \"full_calcs\" : {\r\n \"array\" : [\r\n {\r\n \"framing_type\": \"(Framing Type)\",\r\n \"roof_slope\": \"(Roof Slope)\",\r\n \"rafter_size\": \"(Rafter Size)\",\r\n \"framing_spacing\": \"(Frame Spacing)\" ,\r\n \"decking\": \"(Decking)\",\r\n \"pv_system\": \"(PV System)\",\r\n \"attachment_spacing\": \"(Attachment Spacing)\",\r\n \"roof_material_type\" : \"(Roof Material Type)\",\r\n \"panel_orientation\" : \"(Panel Orientation)\"\r\n }\r\n ]\r\n }\r\n}"},"url":"{{BASE_URL}}/api/external/projects","description":"

Users can utilize the Create Project API to submit PV Roof Mounted Project to the PZSE Portal 2.0 online system. Users can select project types for IEBC Letters, Full Structural Calculations, Electrical Stamp, and Electrical Fault Study with more to be added soon. Please see the parameters below to get started.

Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n

`Content-Type` (Required).	`application/json`
`Authorization` (Required).	`Bearer{{External_Access_Token}}`

BODY PARAMETER DESCRIPTION

`creator_email`

(Required).

The \"E-mail\" of the user that the project will be connected to. The email should be the same as the account used to login to the PZSE Portal 2.0 website.

`name`

(Required).

The \"Name\" of the project. This field is designed for your own record keeping purposes.

`client_po`

(Required).

The \"Project Number\" for the project. This field is designed for your own record keeping purposes.

`description`

The \"Project Description\" for the project. This field is designed to provide extra context on your solar project.

`type`

(Required).

The \"Type of project\" you want to create. Below are the available project types you can select.

iebc-letter The \"International Existing Building Code Letter\" service for residential roof mounted PV projects.
\n
full-structural The \"Full Structural Calculations\" service for residential roof mounted PV projects.
\n
electrical-stamp The \"Electrical Stamp\" service for residenital roof mounted PV projects
\n
electrical-fault-study The \"Electrical Fault Study\" service for residential roof mounted PV projects.
\n
plan-set-iebc-es The \"International Existing Building Code Letter\" with stamped plan-set & \"Electrical Stamp\" services, for residential roof mounted PV projects.
\n
plan-set-iebc-efs The \"International Existing Building Code Letter\" with stamped plan-set & \"Electrical Fault Study\" services, for residential roof mounted PV projects.
\n
plan-set-iebc-es-efs The \"International Existing Building Code Letter\" with stamped plan-set, \"Electrical Stamp,\" and \"Electrical Fault Study\" services, for residential roof mounted PV projects.
\n
plan-set-fs-es The \"Full Structural Calculations\" & \"Electrical Stamp\" services, for residential roof mounted PV projects.
\n
plan-set-fs-efs The \"Full Structural Calculations\" & \"Electrical Fault Study\" services, for residential roof mounted PV projects.
\n
plan-set-fs-es-efs The \"Full Structural Calculations,\" \"Electrical Stamp,\" and \"Electrical Fault Study\" services, for residential roof mounted PV projects.
\n
plan-set-es-efs The \"Electrical Stamp\" & \"Electrical Fault Study\" services, for residential roof mounted PV projects.
\n

`express`

(Optional).
This toggles the project to be an express or non-express project. By default, express is set to false if not provided. Set to true for express project type.

`sp_file`

(Required if express is true). File

The structural plan file to be stamped

`sp_stamp_coordinates`

(Required if express is true). Json

JSON object containing stamp-related configuration for the structural plan

Child parameters

`sp_stamp_coordinates.stamping_profile_id`

(Optional).

The ID of the saved stamping profile from Portal → Profile → Documents → Stamping Profile.
If provided, the x_position, y_position, and pages fields will be ignored.

`sp_stamp_coordinates.design_stamping_profile_id`

(Optional).

The ID of the saved designer criteria stamping profile from Portal → Profile → Documents → Stamping Profile.

`sp_stamp_coordinates.x_position`

(Required if stamping_profile_id is not provided or null).

Specifies the horizontal (X-axis) position of the structural plan stamp.

Valid range -0.6 and 13.5

`sp_stamp_coordinates.y_position`

(Required if stamping_profile_id is not provided or null).

Specifies the vertical (Y-axis) position of the structural plan stamp

Valid range: -0.6 to 7.7

`sp_stamp_coordinates.pages`

(Required if stamping_profile_id is not provided or null).

Indicates which pages should be stamped. Accepts individual page numbers, ranges, or * to represent all pages.

Examples:

* — Stamp all pages
\n
1-5 — Stamp pages 1 through 5
\n
1,2,4-5 — Stamp pages 1, 2, 4, and 5
\n

`add_ons`

The \"Add-on Services\" that you want to add upon project creation.

Child parameters

`add_ons.{index}.name`

(Required).

The \"Name of the add-on services\" for the project. Below are the available options you can select.

wet-stamp Option to request \"Wet-Stamp\" or \"hard copies\" to be shipped to a specific \"shipping profile.\"

`add_ons.{index}.quantity`

(Required if name of addon is `wet-stamp`).

The \"Number\" of wet stamp copies requested.

`shipping_profile`

(Required if add-ons include `wet-stamp`). | json

The \"Shipping Profile\" the wet stamps will be mailed to.

The same combination of addresses will maintain an existing profile and won't create a new one. Currently, the option to modify the contact person associated with an existing shipping profile is unavailable. If you need to update the contact person for a shipping profile, please consult the portal for further instructions.

Child parameters

(Required)

shipping_profile.address_1 The \"Street Address\" for the shipping address.

(Required).

shipping_profile.address_2 The \"Second Street Address\" for the shipping address.

(Optional).

shipping_profile.county The \"Second Street Address\" for the shipping address.

(Required).

shipping_profile.city The \"City\" of the shipping address.

(Required).

shipping_profile.state The \"State\" of the shipping address.

(Required).

shipping_profile.postal_code The \"Zipcode/Postal Code\" of the shipping address.

(Required).

shipping_profile.first_name The \"First Name\" of the receiver for the shipping address.

(Required).

shipping_profile.last_name The \"Last Name\" of the receiver for the shipping address.

(Required).

shipping_profile.phone_number The \"Phone Number\" of the receiver for the shipping address.

(Required).

shipping_profile.email The \"E-mail Address\" of the receiver for the shipping address.

(Required).

shipping_profile.company_name The \"Company Name\" of the receiver for the shipping address.

(Required).

`address`

(Required). | json

The \"Street Address\" of the project. Including the coordinates of the project location.

Child parameters

*Providing longitude and latitude will not populate values like Suite Number, Apartment Number, Unit, and etc.

address.longitude The \"Longitude\" value of the project location. If longitude and latitude are provided, it will override all the values of address_1, county, city, state, postal_codeby retrieving the exact address of the coordinates.

(Optional).

address.latitude The \"Latitude\" value of the project location. If longitude and latitude are provided, it will override all the values of address_1, county, city, state, postal_code by retrieving the exact address of the coordinates.

(Optional).

address.address_1 The \"Street Address\" of the project.

(Required if no longitude and latitude is provided).

address.address_2 The \"Second Street Address\" of the project.

(Optional).

address.county The \"County\" of the project.

(Required if no longitude and latitude is provided).

address.city The \"City\" of the project.

(Required if no longitude and latitude is provided).

address.state The \"State\" of the project.

(Required if no longitude and latitude is provided).

address.postal_code The \"Postal Code\" of the project.

(Required if no longitude and latitude is provided).

`project_meta`

(Required).

The \"Project Metadata\" needed for installation.

Child parameters

project_meta.building_description Building Description of the project installation. Below are the available options.

(Required).

detached-garage
\n
residential-house
\n

project_meta.surrounding_terrain Surrounding Terrain of the project installation. Below are the available options.

(Required).

urban-areas
\n
suburban-areas
\n
rural-areas
\n
open-country
\n
forested-and-wooded-areas
\n
mountainous-region-forested
\n
mountainous-region-sparse-vegetation
\n
costal-site
\n

project_meta.roof_material_type Roof Material Type of the project installation. Below are the available options.

(Required if `type` is `iebc-letter or in plan-set-iebc combination`).

wood-framed-sloped-roof-with-metal-roofing
\n
wood-framed-sloped-roof-with-comp-shingle
\n
wood-framed-sloped-roof-with-concrete-tile
\n
wood-framed-sloped-roof-with-clay-tile
\n
wood-framed-flat-roof-with-bur
\n
wood-framed-flat-roof-with-rolled-comp
\n
wood-framed-flat-roof-with-single-ply-membrane
\n

project_meta.roof_slope Roof slope of the project installation. Roof slope should NOT be greater than 45°

(Required if `type` is `iebc-letter or in plan-set-iebc combination`).

project_meta.roof_type Roof Type of the project installation. Below are the available options. Default to Gable when not provided.

Gable
\n
Hip
\n

project_meta.building_width Building Width of the project in Feet.

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

project_meta.building_length Building Length of the project in Feet.

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

project_meta.number_of_stories Number of stories of the project.

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

project_meta.number_of_panels Number of panels of the project.

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

`full_calcs`

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`)

This variable is used when you want to add full calcs details on full-structural express project.

Child parameters

full_calcs.array.{index}.framing_type Full Calcs item framing type. Below are the available options.

Rafter
\n
Truss
\n

(Required).

full_calcs.array.{index}.roof_slope Roof Slope of the item.

(Required) Numeric.

full_calcs.array.{index}.rafter_size Rafter Size of the item . Below are the available options

2x4
\n
2x6
\n
2x8
\n
2x10
\n
2x12
\n

(Required).

full_calcs.array.{index}.framing_spacing Fraiming Spacing of the item.

(Required) Numeric; Max:48

full_calcs.array.{index}.decking Decking of the item. Below are the available options

Roof Plywood
\n
T&G Decking
\n

(Required).

full_calcs.array.{index}.pv_system PV System of the item. Below are the available options

Railed
\n
Rail-less
\n

(Required).

full_calcs.array.{index}.attachment_spacing Attachment Spacing of the item.

(Required).

full_calcs.array.{index}.roof_material_type Roof Material Type of the item. Below are the available options

Composition Shingle
\n
Conrete 'Flat' or 'S' Tile
\n

(Required).

full_calcs.array.{index}.panel_orientation Panel Orientation of the item. Default Portrait if not provided. Below are the available options

Portrait
\n
Landscape
\n

(Optional).

\n","urlObject":{"path":["api","external","projects"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"b22cbe09-fa45-4ee1-9bc7-c1952a35c8f6","name":"Create Project","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer ","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"creator_email\": \"client.user.external@pzse.com\",\r\n \"name\": \"PZSE Portal Test\",\r\n \"client_po\": \"PO12345\",\r\n \"description\": \"Test Project Description\",\r\n \"type\": \"iebc-letter\",\r\n \"express\": true,\r\n \"address\": {\r\n \"address_1\": \"1478 Stone Point Drive\",\r\n \"address_2\": \"\",\r\n \"city\": \"Roseville\",\r\n \"state\": \"CA\",\r\n \"postal_code\": \"95661\"\r\n },\r\n \"shipping_profile\": {\r\n \"address_1\": \"1478 Stone Point Drive\",\r\n \"address_2\": \"Suite 190\",\r\n \"county\": \"Placerville\",\r\n \"city\": \"Roseville\",\r\n \"state\": \"CA\",\r\n \"postal_code\": \"95661\",\r\n \"first_name\": \"Paul\",\r\n \"last_name\": \"Zacher\",\r\n \"phone_number\": \"(916) 961-3960\",\r\n \"email\": \"portal@pzse.com\",\r\n \"company_name\": \"PZSE Structural Engineers\"\r\n },\r\n \"project_meta\": {\r\n \"building_description\": \"detached-garage\",\r\n \"surrounding_terrain\": \"rural-areas\",\r\n \"roof_material_type\": \"wood-framed-sloped-roof-with-comp-shingle\",\r\n \"roof_slope\": 32\r\n }\r\n}"},"url":"https://api-training.pzse.com/api/external/projects"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"message\": \"Created.\",\n \"result\": {\n \"number\": \"P25-I300515C4R\",\n \"name\": \"PZSE Portal Test\",\n \"description\": \"Test Project Description\",\n \"deltek_project_number\": null,\n \"service\": \"IEBC Letter\",\n \"address\": {\n \"id\": 159,\n \"address_1\": \"1478 Stone Point Drive\",\n \"address_2\": null,\n \"county\": \"Placer County\",\n \"city\": \"Roseville\",\n \"state\": \"CA\",\n \"postal_code\": \"95661\",\n \"longitude\": \"-121.2499974\",\n \"latitude\": \"38.7545435\",\n \"long_address\": \"1478 Stone Point Drive, Placer County, Roseville, CA, 95661\",\n \"short_address\": \"Roseville, CA\",\n \"created_at\": \"2025-05-30T15:23:39.000000Z\",\n \"updated_at\": \"2025-05-30T15:23:39.000000Z\",\n \"deleted_at\": null\n },\n \"project_status\": \"Forwarded To Engineer\",\n \"company_id\": 4,\n \"company_name\": \"Internal Company\",\n \"company_deltek_id\": \"c92c359071084707a4f8d7d24cbee443\",\n \"client_project_number\": \"PO12345\",\n \"wet_stamps_requested\": \"No\",\n \"project_meta\": {\n \"building_description\": {\n \"name\": \"Detached Garage\",\n \"should_refer\": false,\n \"is_commercial\": false,\n \"risk_category\": \"Category I\"\n },\n \"surrounding_terrain\": {\n \"name\": \"Rural Areas\",\n \"should_refer\": false,\n \"exposure_category\": \"C\"\n },\n \"roof_type\": \"Gable\",\n \"building_width\": \"40.00\",\n \"building_length\": \"40.00\",\n \"number_of_stories\": 2,\n \"number_of_panels\": null\n },\n \"submitted_by\": \"Gay Gerlach\",\n \"submittal_date\": \"2025-05-30T15:23:39.000000Z\",\n \"creator_id\": 12,\n \"creator_account_id\": 4,\n \"creator_full_name\": \"Gay Gerlach\",\n \"status\": \"Active\",\n \"is_express\": 1,\n \"has_been_completed_once\": false,\n \"vendor_electrical\": null\n }\n}"}],"_postman_id":"31e2e904-9d5d-41a0-b855-5d7ba712254a"},{"name":"Project Restamp FS","id":"7e3caaba-a9dd-4b8c-b637-9ee936496eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"Project Number - Required","type":"text","description":"

String

\n"},{"key":"project_meta[building_description]","value":"Building Description - Required","type":"text","description":"

Allowed values: (detached-garage, residential-house, none)

\n"},{"key":"project_meta[surrounding_terrain]","value":"Surrounding Terrain - Required","type":"text","description":"

Allowed values: (urban-areas, suburban-areas, rural-areas, open-country, forested-and-wooded-areas, mountainous-region-forested, mountainous-region-sparse-vegetation, costal-site, none)

\n"},{"key":"project_meta[roof_type]","value":"Roof Type - Required","type":"text","description":"

Allowed values: (Gable, Hip)

\n"},{"key":"project_meta[building_width]","value":"Building Width (Feet) - Required","type":"text","description":"

Number

\n"},{"key":"project_meta[building_length]","value":"Building Length (Feet) - Required","type":"text","description":"

Number

\n"},{"key":"project_meta[number_of_stories]","value":"Number of Stories - Required","type":"text","description":"

Number

\n"},{"key":"project_meta[number_of_panels]","value":"Number of Panels - Required","type":"text","description":"

Number

\n"},{"key":"full_calcs[array][0][framing_type]","value":"Framing Type - Required","type":"text","description":"

Allowed values: (Rafter, Truss)

\n"},{"key":"full_calcs[array][0][roof_slope]","value":"Roof Slope - Required","type":"text","description":"

Number

\n"},{"key":"full_calcs[array][0][rafter_size]","value":"Rafter Size - Required","type":"text","description":"

Allowed values: (2x4, 2x6, 2x8, 2x10, 2x12)

\n"},{"key":"full_calcs[array][0][framing_spacing]","value":"Framing Spacing (Inch) - Required","type":"text","description":"

Number (Max 48)

\n"},{"key":"full_calcs[array][0][decking]","value":"Decking - Required","type":"text","description":"

Allowed values: (Roof Plywood, T&G Decking)

\n"},{"key":"full_calcs[array][0][pv_system]","value":"PV System - Required","type":"text","description":"

Allowed values: (Railed, Rail-less)

\n"},{"key":"full_calcs[array][0][attachment_spacing]","value":"Attachment Spacing (Inch) - Required","type":"text","description":"

Number

\n"},{"key":"full_calcs[array][0][roof_material_type]","value":"Roof Material Type - Required","type":"text","description":"

Allowed values: (Composition Shingle, Concrete 'Flat' or 'S' Tile)

\n"},{"key":"full_calcs[array][0][panel_orientation]","value":"Panel Orientation - Required","type":"text","description":"

Allowed values: (Portrait, Landscape)

\n"},{"key":"sp_stamp_coordinates[x_position]","value":"Structural Plan Stamp X Position Coordinate - Required","type":"text","description":"

Number

\n"},{"key":"sp_stamp_coordinates[y_position]","value":"Structural Plan Stamp Y Position Coordinate - Required","type":"text","description":"

Number

\n"},{"key":"sp_stamp_coordinates[design_stamping_profile_id]","value":"Structural Stamp Design Criteria Stamping Profile ID","description":"

\n","type":"text","uuid":"765ccac4-a2eb-41e2-8cfb-ad0c1b57c90d"},{"key":"sp_stamp_coordinates[pages]","value":"Structural Plan Stamp Pages - Required","type":"text","description":"

Allowed values: (*, 1-5)

\n"},{"key":"sp_file","type":"text","uuid":"6fa5d016-ddf8-45ee-8fe0-bb0127772309","value":"Structural Plan File - Required","description":"

File

\n"}]},"url":"{{BASE_URL}}/api/external/projects/restamp","urlObject":{"path":["api","external","projects","restamp"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"a94360bb-c5de-4747-b00d-b294942beec1","name":"Project Restamp FS","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"P25-F060613W1S","type":"text"},{"key":"project_meta[building_description]","value":"detached-garage","type":"text"},{"key":"project_meta[surrounding_terrain]","value":"urban-areas","type":"text"},{"key":"project_meta[roof_type]","value":"Hip","type":"text"},{"key":"project_meta[building_width]","value":"100","type":"text"},{"key":"project_meta[building_length]","value":"100","type":"text"},{"key":"project_meta[number_of_stories]","value":"3","type":"text"},{"key":"project_meta[number_of_panels]","value":"10","type":"text"},{"key":"full_calcs[array][0][framing_type]","value":"Rafter","type":"text"},{"key":"full_calcs[array][0][roof_slope]","value":"10","type":"text"},{"key":"full_calcs[array][0][rafter_size]","value":"2x4","type":"text"},{"key":"full_calcs[array][0][framing_spacing]","value":"5","type":"text"},{"key":"full_calcs[array][0][decking]","value":"Roof Plywood","type":"text"},{"key":"full_calcs[array][0][pv_system]","value":"Rail-less","type":"text"},{"key":"full_calcs[array][0][exposure_category]","value":"Category B","type":"text"},{"key":"full_calcs[array][0][roof_material_type]","value":"Composition Shingle","type":"text"},{"key":"full_calcs[array][0][panel_orientation]","value":"Portrait","type":"text"},{"key":"sp_stamp_coordinates[x_position]","value":"1.5","type":"text"},{"key":"sp_stamp_coordinates[y_position]","value":"5","type":"text"},{"key":"sp_stamp_coordinates[pages]","value":"1,2, 3-5","type":"text"},{"key":"sp_file","type":"file","uuid":"6fa5d016-ddf8-45ee-8fe0-bb0127772309","src":"/Users/MacBook/Downloads/1621 North Gale Avenue, Moore, OK 73160.pdf"}]},"url":"{{BASE_URL}}/api/external/projects/restamp"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"message\": \"OK.\",\r\n \"result\": {\r\n \"number\": \"P25-SET040615M4H\",\r\n \"name\": \"PZSE Portal Final Run 3.0 - FS\",\r\n \"description\": \"This is just a test\",\r\n \"deltek_project_number\": \"2025-02675\",\r\n \"service\": \"Full Structural and Electrical Stamp\",\r\n \"address\": {\r\n \"id\": 185,\r\n \"address_1\": \"913 Aurora Avenue\",\r\n \"address_2\": null,\r\n \"county\": \"Kane County\",\r\n \"city\": \"Aurora\",\r\n \"state\": \"IL\",\r\n \"postal_code\": \"60505\",\r\n \"longitude\": \"-88.3076989\",\r\n \"latitude\": \"41.7764382\",\r\n \"long_address\": \"913 Aurora Avenue, Kane County, Aurora, IL, 60505\",\r\n \"short_address\": \"Aurora, IL\",\r\n \"created_at\": \"2025-06-04T15:36:53.000000Z\",\r\n \"updated_at\": \"2025-06-04T15:36:53.000000Z\",\r\n \"deleted_at\": null\r\n },\r\n \"project_status\": \"Forwarded To Engineer\",\r\n \"company_id\": 4,\r\n \"company_name\": \"Internal Company\",\r\n \"company_deltek_id\": \"c92c359071084707a4f8d7d24cbee443\",\r\n \"client_project_number\": \"PO12345\",\r\n \"wet_stamps_requested\": \"Yes\",\r\n \"project_meta\": {\r\n \"building_description\": {\r\n \"name\": \"Detached Garage\",\r\n \"should_refer\": false,\r\n \"is_commercial\": false,\r\n \"risk_category\": \"Category I\"\r\n },\r\n \"surrounding_terrain\": {\r\n \"name\": \"Urban Areas\",\r\n \"should_refer\": false,\r\n \"exposure_category\": \"B\"\r\n },\r\n \"roof_type\": \"Hip\",\r\n \"building_width\": \"100.00\",\r\n \"building_length\": \"100.00\",\r\n \"number_of_stories\": 3,\r\n \"number_of_panels\": 10\r\n },\r\n \"submitted_by\": \"Gay Gerlach\",\r\n \"submittal_date\": \"2025-06-04T15:36:53.000000Z\",\r\n \"creator_id\": 12,\r\n \"creator_account_id\": 4,\r\n \"creator_full_name\": \"Gay Gerlach\",\r\n \"status\": \"Active\",\r\n \"is_express\": 1,\r\n \"has_been_completed_once\": false,\r\n \"has_requested_post_install\": true,\r\n \"has_value_engineering\": false,\r\n \"vendor_electrical\": {\r\n \"id\": 8,\r\n \"company_name\": \"H2DC\",\r\n \"created_at\": \"2025-02-14T15:46:08.000000Z\",\r\n \"updated_at\": \"2025-02-14T15:46:08.000000Z\"\r\n },\r\n \"full_calcs\": {\r\n \"array\": [\r\n {\r\n \"roof_material_type\": \"Composition Shingle\",\r\n \"decking\": \"Roof Plywood\",\r\n \"roof_slope\": \"10\",\r\n \"framing_type\": \"Rafter\",\r\n \"rafter_size\": \"2x4\",\r\n \"framing_spacing\": \"5\",\r\n \"panel_orientation\": \"Portrait\",\r\n \"pv_system\": \"Rail-less\",\r\n \"attachment_spacing\": \"5\"\r\n }\r\n ]\r\n }\r\n }\r\n}"}],"_postman_id":"7e3caaba-a9dd-4b8c-b637-9ee936496eac"},{"name":"Project Restamp IEBC Express","id":"fe57d9fd-7081-41e5-883d-c681e9fb5ddb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"Project Number - Required","type":"text","description":"

String

\n"},{"key":"project_meta[building_description]","value":"Building Description - Required","type":"text","description":"

Allowed values: (detached-garage, residential-house, None)

\n"},{"key":"project_meta[surrounding_terrain]","value":"Surrounding Terrain - Required","type":"text","description":"

Allowed values: (urban-areas, suburban-areas, rural-areas, open-country, forested-and-wooded-areas, mountainous-region-forested, mountainous-region-sparse-vegetation, costal-site, None)

\n"},{"key":"project_meta[roof_material_type]","value":"Roof Material Type - Required","type":"text","description":"

Allowed values: (wood-framed-sloped-roof-with-metal-roofing, wood-framed-sloped-roof-with-comp-shingle, wood-framed-sloped-roof-with-concrete-tile, wood-framed-sloped-roof-with-clay-tile, wood-framed-flat-roof-with-bur, wood-framed-flat-roof-with-rolled-comp, wood-framed-flat-roof-with-single-ply-membrane, None)

\n"},{"key":"project_meta[roof_slope]","value":"Roof Slope - Required","type":"text","description":"

Number

\n"},{"key":"sp_stamp_coordinates[x_position]","value":"Structural Plan Stamp X Position Coordinate - Required","type":"text","description":"

Number

\n"},{"key":"sp_stamp_coordinates[y_position]","value":"Structural Plan Stamp Y Position Coordinate - Required","type":"text","description":"

Number

\n"},{"key":"sp_stamp_coordinates[pages]","value":"Structural Plan Stamp Pages - Required","type":"text","description":"

Allowed values: (*, 1-5)

\n"},{"key":"sp_stamp_coordinates[design_stamping_profile_id]","value":"Structural Stamp Design Criteria Stamping Profile ID","description":"

\n","type":"text","uuid":"b803183f-bfa2-4a4e-8e35-25c0940da6a8"},{"key":"sp_file","value":"Structural Plan File","type":"text","description":"

File

\n"}]},"url":"{{BASE_URL}}/api/external/projects/restamp","description":"

GET /api/external/projects

\n","urlObject":{"path":["api","external","projects","restamp"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"0a354b94-07d6-491d-bac1-a53c7d079f88","name":"Project Restamp IEBC Express","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"P25-I040614W3K","type":"text"},{"key":"project_meta[building_description]","value":"detached-garage","type":"text"},{"key":"project_meta[surrounding_terrain]","value":"rural-areas","type":"text"},{"key":"project_meta[roof_material_type]","value":"wood-framed-sloped-roof-with-comp-shingle","type":"text"},{"key":"project_meta[roof_slope]","value":"32","type":"text"},{"key":"sp_stamp_coordinates[x_position]","value":"1.5","type":"text"},{"key":"sp_stamp_coordinates[y_position]","value":"5","type":"text"},{"key":"sp_stamp_coordinates[pages]","value":"1,2, 3-5","type":"text"},{"key":"sp_file","type":"file","value":null}]},"url":"{{BASE_URL}}/api/external/projects/restamp"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"message\": \"OK.\",\r\n \"result\": {\r\n \"number\": \"P25-I040614W3K\",\r\n \"name\": \"PZSE Portal Test\",\r\n \"description\": \"Sup Eric\",\r\n \"deltek_project_number\": \"2025-02642\",\r\n \"service\": \"IEBC Letter\",\r\n \"address\": {\r\n \"id\": 184,\r\n \"address_1\": \"1478 Stone Point Drive\",\r\n \"address_2\": null,\r\n \"county\": \"Placer County\",\r\n \"city\": \"Roseville\",\r\n \"state\": \"CA\",\r\n \"postal_code\": \"95661\",\r\n \"longitude\": \"-121.2499974\",\r\n \"latitude\": \"38.7545435\",\r\n \"long_address\": \"1478 Stone Point Drive, Placer County, Roseville, CA, 95661\",\r\n \"short_address\": \"Roseville, CA\",\r\n \"created_at\": \"2025-06-04T14:58:23.000000Z\",\r\n \"updated_at\": \"2025-06-04T14:58:23.000000Z\",\r\n \"deleted_at\": null\r\n },\r\n \"project_status\": \"Forwarded To Engineer\",\r\n \"company_id\": 4,\r\n \"company_name\": \"Internal Company\",\r\n \"company_deltek_id\": \"c92c359071084707a4f8d7d24cbee443\",\r\n \"client_project_number\": \"PO12345\",\r\n \"wet_stamps_requested\": \"No\",\r\n \"project_meta\": {\r\n \"building_description\": {\r\n \"name\": \"Detached Garage\",\r\n \"should_refer\": false,\r\n \"is_commercial\": false,\r\n \"risk_category\": \"Category I\"\r\n },\r\n \"surrounding_terrain\": {\r\n \"name\": \"Rural Areas\",\r\n \"should_refer\": false,\r\n \"exposure_category\": \"C\"\r\n },\r\n \"roof_type\": \"Gable\",\r\n \"building_width\": null,\r\n \"building_length\": null,\r\n \"number_of_stories\": null,\r\n \"number_of_panels\": null\r\n },\r\n \"submitted_by\": \"Gay Gerlach\",\r\n \"submittal_date\": \"2025-06-04T14:58:23.000000Z\",\r\n \"creator_id\": 12,\r\n \"creator_account_id\": 4,\r\n \"creator_full_name\": \"Gay Gerlach\",\r\n \"status\": \"Active\",\r\n \"is_express\": 1,\r\n \"has_been_completed_once\": false,\r\n \"has_requested_post_install\": true,\r\n \"has_value_engineering\": false,\r\n \"vendor_electrical\": null\r\n }\r\n}"}],"_postman_id":"fe57d9fd-7081-41e5-883d-c681e9fb5ddb"},{"name":"Project Post-Install","id":"90d0bbd5-a5d5-43a0-9dc9-f71e3b6e77f2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"Project Number - Required","type":"text","description":"

String

\n"},{"key":"files[]","type":"text","uuid":"6fa5d016-ddf8-45ee-8fe0-bb0127772309","value":"Post Install Files Array - Optional","description":"

Array of Files

\n"},{"key":"type","value":"Post Install Type - Required","description":"

Allowed Values: structural, electrical

\n","type":"text","uuid":"7f3d5436-19ae-4e73-a393-3f649a29469b"}]},"url":"{{BASE_URL}}/api/external/projects/post-install","description":"

GET /api/external/projects

\n","urlObject":{"path":["api","external","projects","post-install"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"698dd72e-4ade-40a8-962e-4ac6345cd7c2","name":"Project Post-Install","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"P25-SET040615M4H","type":"text"},{"key":"files[]","type":"file","uuid":"6fa5d016-ddf8-45ee-8fe0-bb0127772309","src":"/Users/MacBook/Downloads/1621 North Gale Avenue, Moore, OK 73160 copy 2.pdf"},{"key":"type","value":"structural","type":"text","uuid":"0bd6013a-b83d-4328-b06c-9869f0b985df"}]},"url":"{{BASE_URL}}/api/external/projects/post-install"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"message\": \"OK.\",\r\n \"result\": {\r\n \"number\": \"P25-SET040615M4H\",\r\n \"name\": \"PZSE Portal Final Run 3.0 - FS\",\r\n \"description\": \"This is just a test\",\r\n \"deltek_project_number\": \"2025-02675\",\r\n \"service\": \"Full Structural and Electrical Stamp\",\r\n \"address\": {\r\n \"id\": 185,\r\n \"address_1\": \"913 Aurora Avenue\",\r\n \"address_2\": null,\r\n \"county\": \"Kane County\",\r\n \"city\": \"Aurora\",\r\n \"state\": \"IL\",\r\n \"postal_code\": \"60505\",\r\n \"longitude\": \"-88.3076989\",\r\n \"latitude\": \"41.7764382\",\r\n \"long_address\": \"913 Aurora Avenue, Kane County, Aurora, IL, 60505\",\r\n \"short_address\": \"Aurora, IL\",\r\n \"created_at\": \"2025-06-04T15:36:53.000000Z\",\r\n \"updated_at\": \"2025-06-04T15:36:53.000000Z\",\r\n \"deleted_at\": null\r\n },\r\n \"project_status\": \"Forwarded To Engineer\",\r\n \"company_id\": 4,\r\n \"company_name\": \"Internal Company\",\r\n \"company_deltek_id\": \"c92c359071084707a4f8d7d24cbee443\",\r\n \"client_project_number\": \"PO12345\",\r\n \"wet_stamps_requested\": \"Yes\",\r\n \"project_meta\": {\r\n \"building_description\": {\r\n \"name\": \"Detached Garage\",\r\n \"should_refer\": false,\r\n \"is_commercial\": false,\r\n \"risk_category\": \"Category I\"\r\n },\r\n \"surrounding_terrain\": {\r\n \"name\": \"Urban Areas\",\r\n \"should_refer\": false,\r\n \"exposure_category\": \"B\"\r\n },\r\n \"roof_type\": \"Hip\",\r\n \"building_width\": \"100.00\",\r\n \"building_length\": \"100.00\",\r\n \"number_of_stories\": 2,\r\n \"number_of_panels\": 10\r\n },\r\n \"submitted_by\": \"Gay Gerlach\",\r\n \"submittal_date\": \"2025-06-04T15:36:53.000000Z\",\r\n \"creator_id\": 12,\r\n \"creator_account_id\": 4,\r\n \"creator_full_name\": \"Gay Gerlach\",\r\n \"status\": \"Active\",\r\n \"is_express\": 1,\r\n \"has_been_completed_once\": false,\r\n \"has_requested_post_install\": true,\r\n \"vendor_electrical\": {\r\n \"id\": 8,\r\n \"company_name\": \"H2DC\",\r\n \"created_at\": \"2025-02-14T15:46:08.000000Z\",\r\n \"updated_at\": \"2025-02-14T15:46:08.000000Z\"\r\n },\r\n \"full_calcs\": {\r\n \"array\": [\r\n {\r\n \"roof_material_type\": \"Composition Shingle\",\r\n \"decking\": \"Roof Plywood\",\r\n \"roof_slope\": \"10\",\r\n \"framing_type\": \"Rafter\",\r\n \"rafter_size\": \"2x4\",\r\n \"framing_spacing\": \"5\",\r\n \"panel_orientation\": \"Portrait\",\r\n \"pv_system\": \"Rail-less\",\r\n \"attachment_spacing\": \"5\"\r\n }\r\n ]\r\n }\r\n }\r\n}"}],"_postman_id":"90d0bbd5-a5d5-43a0-9dc9-f71e3b6e77f2"},{"name":"Project Post-Install Restamp","id":"ee59f61c-3237-4f88-ae3d-304f814c7948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"Project Number - Required","type":"text","description":"

String

\n"},{"key":"comment","value":"Post Install Comment - Optional","type":"text","uuid":"0510232f-49fe-4b92-8da9-80b141cd6219","description":"

String

\n"},{"key":"files[]","type":"text","uuid":"6fa5d016-ddf8-45ee-8fe0-bb0127772309","value":"Post Install Files Array - Optional","description":"

Array of Files

\n"},{"key":"type","value":"Post Install Type - Required","description":"

Allowed Values: structural, electrical

\n","type":"text","uuid":"cf357d86-bba0-4fec-86bd-32324320b727"}]},"url":"{{BASE_URL}}/api/external/projects/post-install-restamp","description":"

GET /api/external/projects

\n","urlObject":{"path":["api","external","projects","post-install-restamp"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"1fbc7693-f593-4b28-b776-bbf023f74794","name":"Project Post-Install Restamp","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"number","value":"P25-SET040615M4H","type":"text"},{"key":"comment","value":"Test Post Install","type":"text","uuid":"0510232f-49fe-4b92-8da9-80b141cd6219"},{"key":"files[]","type":"file","uuid":"6fa5d016-ddf8-45ee-8fe0-bb0127772309","src":"/Users/MacBook/Downloads/1621 North Gale Avenue, Moore, OK 73160 copy.pdf"},{"key":"type","value":"structural","type":"text","uuid":"2faf23a1-680f-4d67-a125-eb313dcd5521"}]},"url":"{{BASE_URL}}/api/external/projects/post-install-restamp"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\r\n \"status\": 200,\r\n \"message\": \"OK.\",\r\n \"result\": {\r\n \"number\": \"P25-SET040615M4H\",\r\n \"name\": \"PZSE Portal Final Run 3.0 - FS\",\r\n \"description\": \"This is just a test\",\r\n \"deltek_project_number\": \"2025-02675\",\r\n \"service\": \"Full Structural and Electrical Stamp\",\r\n \"address\": {\r\n \"id\": 185,\r\n \"address_1\": \"913 Aurora Avenue\",\r\n \"address_2\": null,\r\n \"county\": \"Kane County\",\r\n \"city\": \"Aurora\",\r\n \"state\": \"IL\",\r\n \"postal_code\": \"60505\",\r\n \"longitude\": \"-88.3076989\",\r\n \"latitude\": \"41.7764382\",\r\n \"long_address\": \"913 Aurora Avenue, Kane County, Aurora, IL, 60505\",\r\n \"short_address\": \"Aurora, IL\",\r\n \"created_at\": \"2025-06-04T15:36:53.000000Z\",\r\n \"updated_at\": \"2025-06-04T15:36:53.000000Z\",\r\n \"deleted_at\": null\r\n },\r\n \"project_status\": \"Forwarded To Engineer\",\r\n \"company_id\": 4,\r\n \"company_name\": \"Internal Company\",\r\n \"company_deltek_id\": \"c92c359071084707a4f8d7d24cbee443\",\r\n \"client_project_number\": \"PO12345\",\r\n \"wet_stamps_requested\": \"Yes\",\r\n \"project_meta\": {\r\n \"building_description\": {\r\n \"name\": \"Detached Garage\",\r\n \"should_refer\": false,\r\n \"is_commercial\": false,\r\n \"risk_category\": \"Category I\"\r\n },\r\n \"surrounding_terrain\": {\r\n \"name\": \"Urban Areas\",\r\n \"should_refer\": false,\r\n \"exposure_category\": \"B\"\r\n },\r\n \"roof_type\": \"Hip\",\r\n \"building_width\": \"100.00\",\r\n \"building_length\": \"100.00\",\r\n \"number_of_stories\": 2,\r\n \"number_of_panels\": 10\r\n },\r\n \"submitted_by\": \"Gay Gerlach\",\r\n \"submittal_date\": \"2025-06-04T15:36:53.000000Z\",\r\n \"creator_id\": 12,\r\n \"creator_account_id\": 4,\r\n \"creator_full_name\": \"Gay Gerlach\",\r\n \"status\": \"Active\",\r\n \"is_express\": 1,\r\n \"has_been_completed_once\": false,\r\n \"has_requested_post_install\": true,\r\n \"has_value_engineering\": false,\r\n \"vendor_electrical\": {\r\n \"id\": 8,\r\n \"company_name\": \"H2DC\",\r\n \"created_at\": \"2025-02-14T15:46:08.000000Z\",\r\n \"updated_at\": \"2025-02-14T15:46:08.000000Z\"\r\n },\r\n \"full_calcs\": {\r\n \"array\": [\r\n {\r\n \"roof_material_type\": \"Composition Shingle\",\r\n \"decking\": \"Roof Plywood\",\r\n \"roof_slope\": \"10\",\r\n \"framing_type\": \"Rafter\",\r\n \"rafter_size\": \"2x4\",\r\n \"framing_spacing\": \"5\",\r\n \"panel_orientation\": \"Portrait\",\r\n \"pv_system\": \"Rail-less\",\r\n \"attachment_spacing\": \"5\"\r\n }\r\n ]\r\n }\r\n }\r\n}"}],"_postman_id":"ee59f61c-3237-4f88-ae3d-304f814c7948"},{"name":"Project Wetstamp","id":"5748648e-2b47-4f38-8aee-ec3cb7863a71","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"number\" : \"Project Number - Required\",\r\n \"quantity\" : \"(Number of Wet stamp copies requested for shipping)\",\r\n \"shipping_profile\" : {\r\n \"address_1\": \"Shipping Address\",\r\n \"address_2\": \"Shipping Address 2\",\r\n \"county\": \"Shipping County\",\r\n \"city\": \"Shipping City\",\r\n \"state\": \"Shipping State\",\r\n \"postal_code\": \"Shipping Postal Code\",\r\n \"first_name\" : \"Shipping Contact First Name\",\r\n \"last_name\" : \"Shipping Contact Last Name\",\r\n \"phone_number\" : \"Shipping Contact Phone Number\",\r\n \"email\" : \"Shipping Contact Email Address\",\r\n \"company_name\" : \"Recieving Company\"\r\n },\r\n}"},"url":"{{BASE_URL}}/api/external/projects/wetstamp","description":"

GET /api/external/projects

\n","urlObject":{"path":["api","external","projects","wetstamp"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"eb618265-189d-4860-89ed-6db164193c45","name":"Project Wetstamp","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"shipping_profile\": {\r\n \"address_1\": \"1478 Stone Point Drive\",\r\n \"address_2\": \"Suite 190\",\r\n \"county\": \"Placerville\",\r\n \"city\": \"Roseville\",\r\n \"state\": \"CA\",\r\n \"postal_code\": \"95661\",\r\n \"first_name\": \"Paul\",\r\n \"last_name\": \"Zacher\",\r\n \"phone_number\": \"(916) 961-3960\",\r\n \"email\": \"portal@pzse.com\",\r\n \"company_name\": \"PZSE Structural Engineers\"\r\n },\r\n \"quantity\" : 1,\r\n \"number\": \"P25-SET051113W2B\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/api/external/projects/wetstamp"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"OK.\",\n \"result\": {\n \"number\": \"P25-SET051113W2B\",\n \"name\": \"1234\",\n \"description\": null,\n \"deltek_project_number\": \"2024-06098\",\n \"service\": \"Sure-Cert and Electrical Stamp\",\n \"address\": {\n \"id\": 220,\n \"address_1\": \"1 Apple Park Way\",\n \"address_2\": null,\n \"county\": \"Santa Clara County\",\n \"city\": \"Cupertino\",\n \"state\": \"CA\",\n \"postal_code\": \"95014\",\n \"longitude\": \"-122.0090039\",\n \"latitude\": \"37.3352923\",\n \"long_address\": \"1 Apple Park Way, Santa Clara County, Cupertino, CA, 95014\",\n \"short_address\": \"Cupertino, CA\",\n \"created_at\": \"2025-10-28T22:09:34.000000Z\",\n \"updated_at\": \"2025-10-28T03:49:45.000000Z\",\n \"deleted_at\": null\n },\n \"project_status\": \"Assigned - Electrical\",\n \"company_id\": 4,\n \"company_name\": \"Internal Company\",\n \"company_deltek_id\": \"c92c359071084707a4f8d7d24cbee443\",\n \"company_logo\": \"http://local.backend.pzse.com/api/external/system-configs/company-logo/4\",\n \"client_project_number\": \"1234\",\n \"wet_stamps_requested\": \"Yes\",\n \"project_meta\": {\n \"building_description\": {\n \"name\": \"Detached Garage\",\n \"should_refer\": false,\n \"is_commercial\": false,\n \"risk_category\": \"Category I\"\n },\n \"surrounding_terrain\": {\n \"name\": \"Urban Areas\",\n \"should_refer\": false,\n \"exposure_category\": \"B\"\n },\n \"roof_type\": \"Gable\",\n \"building_width\": \"12.00\",\n \"building_length\": \"12.00\",\n \"number_of_stories\": 3,\n \"number_of_panels\": 5\n },\n \"submitted_by\": \"Aryanna Dare\",\n \"submittal_date\": \"2025-11-05T13:16:11.000000Z\",\n \"creator_id\": 10,\n \"creator_account_id\": 4,\n \"creator_full_name\": \"Aryanna Dare\",\n \"status\": \"Active\",\n \"is_express\": 1,\n \"has_been_completed_once\": true,\n \"has_requested_post_install\": false,\n \"has_value_engineering\": false,\n \"vendor_electrical\": {\n \"id\": 10,\n \"company_name\": \"Pittman Engineering, Inc\",\n \"created_at\": \"2025-02-14T15:46:08.000000Z\",\n \"updated_at\": \"2025-02-14T15:46:08.000000Z\"\n },\n \"vendor_designer\": null,\n \"latest_wetstamp\": {\n \"id\": 45,\n \"address_id\": 223,\n \"contact_id\": 10,\n \"requestor_id\": null,\n \"wet_stamps\": 1,\n \"tracking_number\": null,\n \"tracking_url\": null,\n \"status\": \"New\",\n \"created_at\": \"2025-11-11T15:26:02.000000Z\",\n \"updated_at\": \"2025-11-11T15:26:02.000000Z\",\n \"deleted_at\": null\n },\n \"full_calcs\": {\n \"array\": [\n {\n \"roof_material_type\": \"Composition Shingle\",\n \"decking\": \"Roof Plywood\",\n \"roof_slope\": 45,\n \"framing_type\": \"Rafter\",\n \"rafter_size\": \"2x4\",\n \"framing_spacing\": \"24\",\n \"panel_orientation\": \"Portrait\",\n \"pv_system\": \"Railed\",\n \"attachment_spacing\": \"23\"\n }\n ]\n },\n \"designer\": {\n \"project\": {\n \"customer_name\": null,\n \"permitting_project_type\": null\n },\n \"contractor\": {\n \"email\": null,\n \"phone\": null,\n \"address\": {\n \"city\": null,\n \"state\": null,\n \"county\": null,\n \"country\": null,\n \"latitude\": null,\n \"address_1\": null,\n \"longitude\": null,\n \"postal_code\": null\n },\n \"license_number\": null,\n \"contractor_name\": null,\n \"expiration_date\": null\n },\n \"electrical\": {\n \"feeder_type\": null,\n \"electrical_notes\": null,\n \"msp_busbar_rating\": null,\n \"msp_breaker_rating\": null,\n \"msp_upgrade_required\": null,\n \"ac_disconnect_required\": null,\n \"interconnection_method\": null,\n \"production_meter_required\": null\n },\n \"structural\": {\n \"roof_type\": null,\n \"racking_make\": null,\n \"racking_model\": null,\n \"wind_exposure\": null,\n \"building_width\": null,\n \"attachment_make\": null,\n \"building_length\": null,\n \"attachment_model\": null,\n \"roofing_material\": null,\n \"number_of_stories\": null,\n \"attachment_pattern\": null,\n \"additional_information\": null\n },\n \"equipment_list\": {\n \"battery_storage\": null,\n \"equipment_notes\": null,\n \"number_of_panels\": null,\n \"solar_plant_size\": null,\n \"number_of_inverter\": null,\n \"inverter_model_name\": null,\n \"battery_manufacturer\": null,\n \"number_of_optimizers\": null,\n \"optimizer_model_name\": null,\n \"pv_module_model_name\": null,\n \"inverter_manufacturer\": null,\n \"optimizer_manufacturer\": null,\n \"pv_module_manufacturer\": null\n }\n }\n }\n}"}],"_postman_id":"5748648e-2b47-4f38-8aee-ec3cb7863a71"}],"id":"aa031112-35ef-414c-bd38-1e7033da17ae","description":"

Users can Utilize the PZSE Portal 2.0 Projects API to perform the following actions for roof mounted PV projects.

Get Projects - Retrieve a series of lists based on page number in PZSE Portal 2.0 website, 10 per page.
Get Project - Retrieve an invidual project based on search parameters.
Post Create Project - Create a new project on the PZSE Portal 2.0 website and retrieve deliverables.

\n","_postman_id":"aa031112-35ef-414c-bd38-1e7033da17ae"},{"name":"Project File Upload","item":[{"name":"Structural Plans File Upload","id":"8e9127ce-6d92-48c5-a908-8155a9493c26","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"(Your project ID)","description":"

Project Id of the file

\n","type":"text"},{"key":"file","description":"

File to be uploaded

\n","type":"file","value":null},{"key":"description","value":"(Your description of the files)","description":"

Description of the document

\n","type":"text"},{"key":"x_position","value":"(Your X position for the stamp)","description":"

Horizontal position of the stamp

\n","type":"text","disabled":true},{"key":"y_position","value":"(Your Y position for the stamp)","description":"

Vertical Position of the stamp

\n","type":"text","disabled":true},{"key":"pages","value":"(Your pages to be stamped)","description":"

Page Range

\n","type":"text","disabled":true}]},"url":"{{BASE_URL}}/api/external/project-file-upload/structural-plans","description":"

Pages you want stamped. Default value is * which means all pages. Ex. 1-3,5 1-5 1,2,3,5

\n","urlObject":{"path":["api","external","project-file-upload","structural-plans"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"90ac4e0a-213d-4d53-9f90-95acc1befb29","name":"Structural Plans File Upload","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"(Your project ID)","description":"Project Id of the file","type":"text"},{"key":"file","description":"File to be uploaded","type":"file","value":null},{"key":"description","value":"(Your description of the files)","description":"Description of the document","type":"text"},{"key":"x_position","value":"(Your X position for the stamp)","description":"Horizontal position of the stamp","type":"text","disabled":true},{"key":"y_position","value":"(Your Y position for the stamp)","description":"Vertical Position of the stamp","type":"text","disabled":true},{"key":"pages","value":"(Your pages to be stamped)","description":"Page Range","type":"text","disabled":true}]},"url":"{{BASE_URL}}/api/external/project-file-upload/structural-plans"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 201,\r\n \"message\": \"Created.\",\r\n \"result\": {\r\n \"file_id\": 34,\r\n \"project_document_id\": 34,\r\n \"url\": \"https://api-training.pzse.com/storage/projects/18/ARCH/167454849163cf950bd4009.pdf\",\r\n \"pathname\": \"projects/18/ARCH\",\r\n \"original_filename\": \"P23-I190123YPL-282624_Tyler Higdon_PERMIT_PLANSET-1-19-Stamped.pdf\",\r\n \"unique_filename\": \"167454849163cf950bd4009.pdf\",\r\n \"mime_type\": \"application/pdf\",\r\n \"is_generated\": false,\r\n \"created_at\": \"2023-01-24T08:21:31.000000Z\",\r\n \"updated_at\": \"2023-01-24T08:21:31.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n}"}],"_postman_id":"8e9127ce-6d92-48c5-a908-8155a9493c26"},{"name":"Pre-Install Photos File Upload","id":"51b6dad0-1c45-4f82-9bf5-5c5207b45370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"(Your Project ID)","description":"

Project Id of the file

\n","type":"text"},{"key":"file","description":"

File to be uploaded

\n","type":"file","value":null}]},"url":"{{BASE_URL}}/api/external/project-file-upload/pre-install-photos","description":"

Users can utilize the Pre-Install Photos File Upload API to add site survey photos for Full Structural Calculations Requests.

\n","urlObject":{"path":["api","external","project-file-upload","pre-install-photos"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"e85d42cd-dd51-4ad2-9260-7cdb40d6159d","name":"Pre-Install Photos File Upload","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"(Your Project ID)","description":"Project Id of the file","type":"text"},{"key":"file","description":"File to be uploaded","type":"file","value":null}]},"url":"{{BASE_URL}}/api/external/project-file-upload/pre-install-photos"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"status\": 201,\r\n \"message\": \"Created.\",\r\n \"result\": {\r\n \"file_id\": 35,\r\n \"project_document_id\": 35,\r\n \"url\": \"https://api-training.pzse.com/storage/projects/18/ARCH/Survey/Photos/Pre_Install/167454851963cf95279fee6/pdf\",\r\n \"pathname\": \"projects/18/ARCH/Survey/Photos/Pre_Install\",\r\n \"original_filename\": \"P22-00002-Project 1-IEBC-Letter-Stamped.pdf\",\r\n \"unique_filename\": \"167454851963cf95279fee6.pdf\",\r\n \"mime_type\": \"application/pdf\",\r\n \"is_generated\": false,\r\n \"created_at\": \"2023-01-24T08:21:59.000000Z\",\r\n \"updated_at\": \"2023-01-24T08:21:59.000000Z\",\r\n \"deleted_at\": null\r\n }\r\n}"}],"_postman_id":"51b6dad0-1c45-4f82-9bf5-5c5207b45370"},{"name":"Miscellaneous File Upload","id":"08962876-468d-404b-9149-d8dd8e0cd76e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"(Your Project ID)","description":"

Project Id of the file

\n","type":"text"},{"key":"file","description":"

File to be uploaded

\n","type":"file","value":null}]},"url":"{{BASE_URL}}/api/external/project-file-upload/misc","description":"

Users can utilize the Pre-Install Photos File Upload API to add site survey photos for Full Structural Calculations Requests.

\n","urlObject":{"path":["api","external","project-file-upload","misc"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"daaa0d42-d3ba-4ce4-8451-1b8932343217","name":"Miscellaneous File Upload","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"(Your Project ID)","description":"Project Id of the file","type":"text"},{"key":"file","description":"File to be uploaded","type":"file","value":null}]},"url":"{{BASE_URL}}/api/external/project-file-upload/misc"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 201,\n \"message\": \"Created.\",\n \"result\": {\n \"file_id\": 36,\n \"project_document_id\": 36,\n \"url\": \"https://api-training.pzse.com/storage/projects/18/ARCH/Misc/167454855063cf9546d1234/pdf\",\n \"pathname\": \"projects/18/ARCH/Misc\",\n \"original_filename\": \"P22-00002-Project 1-IEBC-Letter-Stamped.pdf\",\n \"unique_filename\": \"167454855063cf9546d1234.pdf\",\n \"mime_type\": \"application/pdf\",\n \"is_generated\": false,\n \"created_at\": \"2023-01-24T08:22:30.000000Z\",\n \"updated_at\": \"2023-01-24T08:22:30.000000Z\",\n \"deleted_at\": null\n }\n}"}],"_postman_id":"08962876-468d-404b-9149-d8dd8e0cd76e"},{"name":"Photos File Upload","id":"401b547e-e2c3-44aa-9705-d25d2a149c4a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"P22-I121215UDV","description":"

Project Id of the file

\n","type":"text"},{"key":"file","description":"

File to be uploaded

\n","type":"file","src":"jD_BjVY6r/P22-00002-Project 1-IEBC-Letter-Stamped.pdf"}]},"url":"{{BASE_URL}}/api/external/project-file-upload/photos","description":"

Users can utilize the Pre-Install Photos File Upload API to add site survey photos for Full Structural Calculations Requests.

\n","urlObject":{"path":["api","external","project-file-upload","photos"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"fcdb8f8a-8171-4578-9207-6604dceaf480","name":"Photos File Upload","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"},{"warning":"This is a duplicate header and will be overridden by the Content-Type header generated by Postman.","key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"Bearer {{EXTERNAL_ACCESS_TOKEN}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"project_id","value":"P22-I121215UDV","description":"Project Id of the file","type":"text"},{"key":"file","description":"File to be uploaded","type":"file","src":"jD_BjVY6r/P22-00002-Project 1-IEBC-Letter-Stamped.pdf"}]},"url":"{{BASE_URL}}/api/external/project-file-upload/photos"},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"401b547e-e2c3-44aa-9705-d25d2a149c4a"}],"id":"c0a6278b-d36f-4f5d-894c-d0ee9138ba5e","description":"

Project Id of the file

\n","urlObject":{"path":["api","external","project-file-download","{{PROJECT_ID}}","photos"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ad3c003c-8c38-4f81-a365-68aa1e382090"}],"id":"04cae6f8-5be0-4f36-ab9a-e24137baa106","description":"

Users can Utilize the Project File Download API to retrieve their completed deliverables for a project submitted with the PZSE Portal 2.0 API.

\n","_postman_id":"04cae6f8-5be0-4f36-ab9a-e24137baa106"},{"name":"Pdf","item":[{"name":"Preview Stamping PDF","id":"366ecd50-a209-4530-a588-d40f9cb95515","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\r\n \"x_position\" : 0.6,\r\n \"y_position\" : 0.6,\r\n \"orientation\" : \"landscape\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/api/external/pdf/preview","description":"

StartFragment

x_position

(Required).

X Position of the stamp preview

EndFragment

y_position

(Required).

Y Position of the stamp preview

orientation

(Required).

Orientation of the stamp preview

EndFragment

\n","urlObject":{"path":["api","external","pdf","preview"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"366ecd50-a209-4530-a588-d40f9cb95515"}],"id":"74ace9c9-cbb8-467c-864e-cd2d08a90aaa","description":"

StartFragment

Users can Utilize the PDF API to preview the stamped version of a file provided with x, y coordinate and orientation

EndFragm

\n","_postman_id":"74ace9c9-cbb8-467c-864e-cd2d08a90aaa"},{"name":"Calculator","item":[{"name":"PV Racking","item":[{"name":"Calculate PV Racking","id":"2d939b13-5a11-4ba8-96ea-e283bb350afc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{EXTERNAL_ACCESS_TOKEN}}"}]},"isInherited":false},"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"system_details\": {\n \"pv_system_type\": \"Flush Mount\",\n \"module_name\": \"18a75246-a9b0-4000-8686-6f1e631b8400\",\n \"module_length\": 65.04,\n \"module_width\": 39.13,\n \"module_thickness\": 1.77,\n \"rail_name\": \"SnapNrack UR-40 Rail\",\n \"clamp_spacing\": 0.75,\n \"roof_attachment\": \"SpeedSeal Foot\"\n },\n \"site_parameters\": {\n \"snow\": {\n \"ground_snow_load\": 0,\n \"reducible_snow_load\": \"Yes\",\n \"thermal_factor\": 1.1,\n \"snow_exposure\": \"Partially Exposed\",\n \"slippery_surface\": \"No\",\n \"room_to_slide\": \"No\"\n },\n \"wind\": {\n \"basic_wind_speed\": 140,\n \"wind_exposure\": \"B\",\n \"site_elevation\": 0,\n \"controlling_wind_zone\": \"1'\"\n },\n \"structure\": {\n \"mean_roof_height\": 0,\n \"least_horizontal_building_dimensions\": 36,\n \"roof_pitch\": 27,\n \"panel_angel\": 27,\n \"roof_type\": \"Hip\",\n \"framing_spacing\": 16\n }\n },\n \"code\": {\n \"asce_7_version\": \"ASCE 7-16\"\n }\n}\n","options":{"raw":{"language":"json"}}},"url":"{{BASE_URL}}/api/external/calculator/pv-racking","description":"

Just like other endpoints in this documentation this is using external user authentication.
In order to make the request required to include Bearer token from authentication endpoint as an authentication method.

The request body example is shown in the example request below. The filed types (integer/string) are matching the given example.

All fields are required, if one of fields will be missing you will get a validation error response shown below. (To expand it toggle 'Example success response'/ 'Example error response' )

\n","urlObject":{"path":["api","external","calculator","pv-racking"],"host":["{{BASE_URL}}"],"query":[],"variable":[]}},"response":[{"id":"2b9b55d6-c000-4cca-9a65-eac526a63bd6","name":"Example Success Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"system_details\": {\n \"pv_system_type\": \"Railless\",\n \"module_name\": \"Generic 60-Cell Module\",\n \"module_length\": 64.5,\n \"module_width\": 39.4,\n \"module_thickness\": 1.6,\n \"rail_name\": \"RL Universal Rail-less\",\n \"clamp_spacing\": 0.7,\n \"roof_attachment\": \"SpeedSeal DeckTrack - Deck Mount (ES)\"\n },\n \"site_parameters\": {\n \"snow\": {\n \"ground_snow_load\": 0,\n \"reducible_snow_load\": \"Yes\",\n \"thermal_factor\": 1.1,\n \"snow_exposure\": \"Partially Exposed\",\n \"slippery_surface\": \"No\",\n \"room_to_slide\": \"Yes\"\n },\n \"wind\": {\n \"basic_wind_speed\": 115,\n \"wind_exposure\": \"B\",\n \"site_elevation\": 0,\n \"controlling_wind_zone\": \"2e\"\n },\n \"structure\": {\n \"mean_roof_height\": 15,\n \"least_horizontal_building_dimensions\": 36,\n \"roof_pitch\": 27,\n \"panel_angel\": 27,\n \"roof_type\": \"Gable\",\n \"framing_spacing\": 16\n }\n },\n \"code\": {\n \"asce_7_version\": \"ASCE 7-16\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"{{BASE_URL}}/api/calculator/pv-racking?api_key=a4c5ef85-65dc-4d1b-967a-70fac859a856","host":["{{BASE_URL}}"],"path":["api","calculator","pv-racking"],"query":[{"key":"api_key","value":"a4c5ef85-65dc-4d1b-967a-70fac859a856"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Vary","value":"Accept-Encoding"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 29 May 2023 19:26:35 GMT"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"499"},{"key":"Access-Control-Allow-Origin","value":"*"},{"key":"X-Frame-Options","value":"SAMEORIGIN"},{"key":"X-XSS-Protection","value":"1; mode=block"},{"key":"X-Content-Type-Options","value":"nosniff"},{"key":"Content-Encoding","value":"gzip"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 200,\n \"message\": \"Success\",\n \"result\": {\n \"attachment_spacing_results\": {\n \"pt_int_max_span_1_prime\": \"NA\",\n \"pt_int_max_span_1\": 48,\n \"pt_int_max_span_2_eave\": 48,\n \"pt_int_max_span_2_ridge\": 48,\n \"pt_int_max_span_2_n_edge\": 48,\n \"pt_int_max_span_3_eave\": 48,\n \"pt_int_max_span_3_ridge\": 48,\n \"ls_int_max_span_1_prime\": \"NA\",\n \"ls_int_max_span_1\": 72,\n \"ls_int_max_span_2_eave\": 72,\n \"ls_int_max_span_2_ridge\": 72,\n \"ls_int_max_span_2_n_edge\": 72,\n \"ls_int_max_span_3_eave\": 72,\n \"ls_int_max_span_3_ridge\": 72,\n \"pt_exposed_max_span_1_prime\": \"NA\",\n \"pt_exposed_max_span 1\": 48,\n \"pt_exposed_max_span_2_eave\": 48,\n \"pt_exposed_max_span_2_ridge\": 48,\n \"pt_exposed_max_span_2_n_edge\": 48,\n \"pt_exposed_max_span_3_eave\": 48,\n \"pt_exposed_max_span_3_ridge\": 48,\n \"ls_exposed_max_span_1_prime\": \"NA\",\n \"ls_exposed_max_span_1\": 72,\n \"ls_exposed_max_span_2_eave\": 72,\n \"ls_exposed_max_span_2_ridge\": 72,\n \"ls_exposed_max_span_2_n_edge\": 72,\n \"ls_exposed_max_span_3_eave\": 72,\n \"ls_exposed_max_span_3_ridge\": 72,\n \"pt_int_installed_span_1_prime\": \"NA\",\n \"pt_int_installed_span_1\": 48,\n \"pt_int_installed_span_2_eave\": 48,\n \"pt_int_installed_span_2_ridge\": 48,\n \"pt_int_installed_span_2_n_edge\": 48,\n \"pt_int_installed_span_3_eave\": 48,\n \"pt_int_installed_span_3_ridge\": 48,\n \"ls_int_installed_span_1_prime\": \"NA\",\n \"ls_int_installed_span_1\": 64,\n \"ls_int_installed_span_2_eave\": 64,\n \"ls_int_installed_span_2_ridge\": 64,\n \"ls_int_installed_span_2_n_edge\": 64,\n \"ls_int_installed_span_3_eave\": 64,\n \"ls_int_installed_span_3_ridge\": 64,\n \"pt_exposed_installed_span_1_prime\": \"NA\",\n \"pt_exposed_installed_span_1\": 48,\n \"pt_exposed_installed_span_2_eave\": 48,\n \"pt_exposed_installed_span_2_ridge\": 48,\n \"pt_exposed_installed_span_2_n_edge\": 48,\n \"pt_exposed_installed_span_3_eave\": 48,\n \"pt_exposed_installed_span_3_ridge\": 48,\n \"ls_exposed_installed_span_1_prime\": \"NA\",\n \"ls_exposed_installed_span_1\": 64,\n \"ls_exposed_installed_span_2_eave\": 64,\n \"ls_exposed_installed_span_2_ridge\": 64,\n \"ls_exposed_installed_span_2_n_edge\": 64,\n \"ls_exposed_installed_span_3_eave\": 64,\n \"ls_exposed_installed_span_3_ridge\": 64\n },\n \"mount_reactions\": {\n \"pt_int_up_rxn_1_prime\": \"NA\",\n \"pt_int_up_rxn_1\": 219.7407760163102,\n \"pt_int_up_rxn_2_eave\": 219.7407760163102,\n \"pt_int_up_rxn_2_ridge\": 219.7407760163102,\n \"pt_int_up_rxn_2_n_edge\": 247.9877458499102,\n \"pt_int_up_rxn_3_eave\": 247.9877458499102,\n \"pt_int_up_rxn_3_ridge\": 247.9877458499102,\n \"pt_int_down_rxn_1_prime\": \"NA\",\n \"pt_int_down_rxn_1\": 263.8699208101497,\n \"pt_int_down_rxn_2_eave\": 263.8699208101497,\n \"pt_int_down_rxn_2_ridge\": 263.8699208101497,\n \"pt_int_down_rxn_2_n_edge\": 263.8699208101497,\n \"pt_int_down_rxn_3_eave\": 263.8699208101497,\n \"pt_int_down_rxn_3_ridge\": 263.8699208101497,\n \"pt_int_side_rxn_1_prime\": \"NA\",\n \"pt_int_side_rxn_1\": 67.90217401762139,\n \"pt_int_side_rxn_2_eave\": 67.90217401762139,\n \"pt_int_side_rxn_2_ridge\": 67.90217401762139,\n \"pt_int_side_rxn_2_n_edge\": 67.90217401762139,\n \"pt_int_side_rxn_3_eave\": 67.90217401762139,\n \"pt_int_side_rxn_3_ridge\": 67.90217401762139,\n \"ls_int_up_rxn_1_prime\": \"NA\",\n \"ls_int_up_rxn_1\": 178.9723323006227,\n \"ls_int_up_rxn_2_eave\": 178.9723323006227,\n \"ls_int_up_rxn_2_ridge\": 178.9723323006227,\n \"ls_int_up_rxn_2_n_edge\": 201.97864984984935,\n \"ls_int_up_rxn_3_eave\": 201.97864984984935,\n \"ls_int_up_rxn_3_ridge\": 201.97864984984935,\n \"ls_int_down_rxn_1_prime\": \"NA\",\n \"ls_int_down_rxn_1\": 214.91420940402892,\n \"ls_int_down_rxn_2_eave\": 214.91420940402892,\n \"ls_int_down_rxn_2_ridge\": 214.91420940402892,\n \"ls_int_down_rxn_2_n_edge\": 214.91420940402892,\n \"ls_int_down_rxn_3_eave\": 214.91420940402892,\n \"ls_int_down_rxn_3_ridge\": 214.91420940402892,\n \"ls_int_side_rxn_1_prime\": \"NA\",\n \"ls_int_side_rxn_1\": 55.30430297249163,\n \"ls_int_side_rxn_2_eave\": 55.30430297249163,\n \"ls_int_side_rxn_2_ridge\": 55.30430297249163,\n \"ls_int_side_rxn_2_n_edge\": 55.30430297249163,\n \"ls_int_side_rxn_3_eave\": 55.30430297249163,\n \"ls_int_side_rxn_3_ridge\": 55.30430297249163,\n \"pt_exposed_up_rxn_1_prime\": \"NA\",\n \"pt_exposed_up_rxn 1\": 128.5922168513551,\n \"pt_exposed_up_rxn_2_eave\": 128.5922168513551,\n \"pt_exposed_up_rxn_2_ridge\": 128.5922168513551,\n \"pt_exposed_up_rxn_2_n_edge\": 144.79590497295513,\n \"pt_exposed_up_rxn_3_eave\": 144.79590497295513,\n \"pt_exposed_up_rxn_3_ridge\": 144.79590497295513,\n \"pt_exposed_down_rxn_1_prime\": \"NA\",\n \"pt_exposed_down_rxn_1\": 131.93496040507486,\n \"pt_exposed_down_rxn_2_eave\": 131.93496040507486,\n \"pt_exposed_down_rxn_2_ridge\": 131.93496040507486,\n \"pt_exposed_down_rxn_2_n_edge\": 131.93496040507486,\n \"pt_exposed_down_rxn_3_eave\": 131.93496040507486,\n \"pt_exposed_down_rxn_3_ridge\": 131.93496040507486,\n \"pt_exposed_side_rxn_1_prime\": \"NA\",\n \"pt_exposed_side_rxn_1\": 33.951087008810696,\n \"pt_exposed_side_rxn_2_eave\": 33.951087008810696,\n \"pt_exposed_side_rxn_2_ridge\": 33.951087008810696,\n \"pt_exposed_side_rxn_2_n_edge\": 33.951087008810696,\n \"pt_exposed_side_rxn_3_eave\": 33.951087008810696,\n \"pt_exposed_side_rxn_3_ridge\": 33.951087008810696,\n \"ls_exposed_up_rxn_1_prime\": \"NA\",\n \"ls_exposed_up_rxn_1\": 114.44860460791132,\n \"ls_exposed_up_rxn_2_eave\": 114.44860460791132,\n \"ls_exposed_up_rxn_2_ridge\": 114.44860460791132,\n \"ls_exposed_up_rxn_2_n_edge\": 128.72536765559133,\n \"ls_exposed_up_rxn_3_eave\": 128.72536765559133,\n \"ls_exposed_up_rxn_3_ridge\": 128.72536765559133,\n \"ls_exposed_down_rxn_1_prime\": \"NA\",\n \"ls_exposed_down_rxn_1\": 107.45710470201446,\n \"ls_exposed_down_rxn_2_eave\": 107.45710470201446,\n \"ls_exposed_down_rxn_2_ridge\": 107.45710470201446,\n \"ls_exposed_down_rxn_2_n_edge\": 107.45710470201446,\n \"ls_exposed_down_rxn_3_eave\": 107.45710470201446,\n \"ls_exposed_down_rxn_3_ridge\": 107.45710470201446,\n \"ls_exposed_side_rxn_1_prime\": \"NA\",\n \"ls_exposed_side_rxn_1\": 27.652151486245813,\n \"ls_exposed_side_rxn_2_eave\": 27.652151486245813,\n \"ls_exposed_side_rxn_2_ridge\": 27.652151486245813,\n \"ls_exposed_side_rxn_2_n_edge\": 27.652151486245813,\n \"ls_exposed_side_rxn_3_eave\": 27.652151486245813,\n \"ls_exposed_side_rxn_3_ridge\": 27.652151486245813,\n \"pt_cantilever_up_rxn_1_prime\": \"NA\",\n \"pt_cantilever_up_rxn_1\": 208.27477085497515,\n \"pt_cantilever_up_rxn_2_eave\": 208.27477085497515,\n \"pt_cantilever_up_rxn_2_ridge\": 208.27477085497515,\n \"pt_cantilever_up_rxn_2_n_edge\": 234.60918543942518,\n \"pt_cantilever_up_rxn_3_eave\": 234.60918543942518,\n \"pt_cantilever_up_rxn_3_ridge\": 234.60918543942518,\n \"pt_cantilever_down_rxn_1_prime\": \"NA\",\n \"pt_cantilever_down_rxn_1\": 219.89160067512475,\n \"pt_cantilever_down_rxn_2_eave\": 219.89160067512475,\n \"pt_cantilever_down_rxn_2_ridge\": 219.89160067512475,\n \"pt_cantilever_down_rxn_2_n_edge\": 219.89160067512475,\n \"pt_cantilever_down_rxn_3_eave\": 219.89160067512475,\n \"pt_cantilever_down_rxn_3_ridge\": 219.89160067512475,\n \"pt_cantilever_side_rxn_1_prime\": \"NA\",\n \"pt_cantilever_side_rxn_1\": 56.5851450146845,\n \"pt_cantilever_side_rxn_2_eave\": 56.5851450146845,\n \"pt_cantilever_side_rxn_2_ridge\": 56.5851450146845,\n \"pt_cantilever_side_rxn_2_n_edge\": 56.5851450146845,\n \"pt_cantilever_side_rxn_3_eave\": 56.5851450146845,\n \"pt_cantilever_side_rxn_3_ridge\": 56.5851450146845,\n \"ls_cantilever_up_rxn_1_prime\": \"NA\",\n \"ls_cantilever_up_rxn_1\": 149.59675040092702,\n \"ls_cantilever_up_rxn_2_eave\": 149.59675040092702,\n \"ls_cantilever_up_rxn_2_ridge\": 149.59675040092702,\n \"ls_cantilever_up_rxn_2_n_edge\": 168.55898869345367,\n \"ls_cantilever_up_rxn_3_eave\": 168.55898869345367,\n \"ls_cantilever_up_rxn_3_ridge\": 168.55898869345367,\n \"ls_cantilever_down_rxn_1_prime\": \"NA\",\n \"ls_cantilever_down_rxn_1\": 161.18565705302169,\n \"ls_cantilever_down_rxn_2_eave\": 161.18565705302169,\n \"ls_cantilever_down_rxn_2_ridge\": 161.18565705302169,\n \"ls_cantilever_down_rxn_2_n_edge\": 161.18565705302169,\n \"ls_cantilever_down_rxn_3_eave\": 161.18565705302169,\n \"ls_cantilever_down_rxn_3_ridge\": 161.18565705302169,\n \"ls_cantilever_side_rxn_1_prime\": \"NA\",\n \"ls_cantilever_side_rxn_1\": 41.47822722936871,\n \"ls_cantilever_side_rxn_2_eave\": 41.47822722936871,\n \"ls_cantilever_side_rxn_2_ridge\": 41.47822722936871,\n \"ls_cantilever_side_rxn_2_n_edge\": 41.47822722936871,\n \"ls_cantilever_side_rxn_3_eave\": 41.47822722936871,\n \"ls_cantilever_side_rxn_3_ridge\": 41.47822722936871\n },\n \"effective_module_presure\": {\n \"wind_ent_up_1_prime\": \"NA\",\n \"wind_ent_up_1\": -19.707188256000002,\n \"wind_ent_up_2_eave\": -19.707188256000002,\n \"wind_ent_up_2_ridge\": -19.707188256000002,\n \"wind_ent_up_2_n_edge\": -21.896875840000003,\n \"wind_ent_up_3_eave\": -21.896875840000003,\n \"wind_ent_up_3_ridge\": -21.896875840000003,\n \"wind_ent_uown_1_prime\": \"NA\",\n \"wind_ent_down_1\": 16,\n \"wind_ent_down_2_eave\": 16,\n \"wind_ent_down_2_ridge\": 16,\n \"wind_ent_down_2_n_edge\": 16,\n \"wind_ent_down_3_eave\": 16,\n \"wind_ent_down_3_ridge\": 16,\n \"wind_exposed_up_1_prime\": \"NA\",\n \"wind_exposed_up_1\": -22.609797378976747,\n \"wind_exposed_up_2_eave\": -22.609797378976747,\n \"wind_exposed_up_2_ridge\": -22.609797378976747,\n \"wind_exposed_up_2_n_edge\": -25.121997087751943,\n \"wind_exposed_up_3_eave\": -25.121997087751943,\n \"wind_exposed_up_3_ridge\": -25.121997087751943,\n \"wind_exposed_down_1_prime\": \"NA\",\n \"wind_exposed_down_1\": 16,\n \"wind_exposed_down_2_eave\": 16,\n \"wind_exposed_down_2_ridge\": 16,\n \"wind_exposed_down_2_n_edge\": 16,\n \"wind_exposed_down_3_eave\": 16,\n \"wind_exposed_down_3_ridge\": 16,\n \"snow_1_prime\": \"NA\",\n \"snow_1\": 0,\n \"snow_2_eave\": 0,\n \"snow_2_ridge\": 0,\n \"snow_2_n_edge\": 0,\n \"snow_3_eave\": 0,\n \"snow_3_ridge\": 0\n }\n }\n}"},{"id":"ea342078-b862-447d-9b12-7c8e267342b5","name":"Example Error Response","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"system_details\": {\n \"module_width\": 39.4,\n \"module_thickness\": 1.6,\n \"rail_name\": \"RL Universal Rail-less\",\n \"clamp_spacing\": 0.7,\n \"roof_attachment\": \"SpeedSeal DeckTrack - Deck Mount (ES)\"\n },\n \"site_parameters\": {\n \"snow\": {\n \"ground_snow_load\": 0,\n \"reducible_snow_load\": \"Yes\",\n \"thermal_factor\": 1.1,\n \"snow_exposure\": \"Partially Exposed\",\n \"slippery_surface\": \"No\",\n \"room_to_slide\": \"Yes\"\n },\n \"wind\": {\n \"basic_wind_speed\": 115,\n \"wind_exposure\": \"B\",\n \"site_elevation\": 0,\n \"controlling_wind_zone\": \"2e\"\n },\n \"structure\": {\n \"mean_roof_height\": 15,\n \"least_horizontal_building_dimensions\": 36,\n \"roof_pitch\": 27,\n \"panel_angel\": 27,\n \"roof_type\": \"Gable\",\n \"framing_spacing\": 16\n }\n },\n \"code\": {\n \"asce_7_version\": \"ASCE 7-16\"\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"https://api-training.pzse.com/api/calculator/pv-racking?api_key=a4c5ef85-65dc-4d1b-967a-70fac859a856","protocol":"https","host":["api-training","pzse","com"],"path":["api","calculator","pv-racking"],"query":[{"key":"api_key","value":"a4c5ef85-65dc-4d1b-967a-70fac859a856"}]}},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Server","value":"nginx"},{"key":"Content-Type","value":"application/json"},{"key":"Transfer-Encoding","value":"chunked"},{"key":"Connection","value":"keep-alive"},{"key":"Cache-Control","value":"no-cache, private"},{"key":"Date","value":"Mon, 29 May 2023 19:27:24 GMT"},{"key":"X-RateLimit-Limit","value":"500"},{"key":"X-RateLimit-Remaining","value":"498"},{"key":"Access-Control-Allow-Origin","value":"*"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": 422,\n \"error_code\": \"unprocessableEntity\",\n \"message\": \"Unprocessable Content.\",\n \"errors\": {\n \"system_details.pv_system_type\": \"The system details.pv system type field is required.\",\n \"system_details.module_name\": \"The system details.module name field is required.\",\n \"system_details.module_length\": \"The system details.module length field is required.\"\n },\n \"data\": {}\n}"}],"_postman_id":"2d939b13-5a11-4ba8-96ea-e283bb350afc"}],"id":"ea44d546-f0ba-400e-a1c4-3bd921a74389","_postman_id":"ea44d546-f0ba-400e-a1c4-3bd921a74389","description":""}],"id":"1990e722-7c14-4a35-b625-8b6c50acd1c4","description":"

NOTE: For auth for the Calculator API, please contact florenceb@yanceyworks.com for your unique access information

\n","_postman_id":"1990e722-7c14-4a35-b625-8b6c50acd1c4"}]}

Request Headers

BODY PARAMETER DESCRIPTION

creator_email

(Required).

name

(Required).

client_po

(Required).

description

type

(Required).

express

sp_file

(Required if express is true). File

sp_stamp_coordinates

(Required if express is true). Json

Child parameters

sp_stamp_coordinates.stamping_profile_id

(Optional).

sp_stamp_coordinates.design_stamping_profile_id

(Optional).

sp_stamp_coordinates.x_position

(Required if stamping_profile_id is not provided or null).

sp_stamp_coordinates.y_position

(Required if stamping_profile_id is not provided or null).

sp_stamp_coordinates.pages

(Required if stamping_profile_id is not provided or null).

add_ons

Child parameters

add_ons.{index}.name

(Required).

add_ons.{index}.quantity

(Required if name of addon is wet-stamp).

shipping_profile

(Required if add-ons include wet-stamp). | json

Child parameters

(Required).

(Optional).

(Required).

(Required).

(Required).

(Required).

(Required).

(Required).

(Required).

(Required).

(Required).

address

(Required). | json

Child parameters

(Optional).

(Optional).

(Required if no longitude and latitude is provided).

(Optional).

(Required if no longitude and latitude is provided).

(Required if no longitude and latitude is provided).

(Required if no longitude and latitude is provided).

(Required if no longitude and latitude is provided).

project_meta

(Required).

Child parameters

(Required).

(Required).

(Required if type is iebc-letter or in plan-set-iebc combination).

(Required if type is iebc-letter or in plan-set-iebc combination).

(Optional) (Required if type is full-structural or plan-set-fs combination and express is true) Numeric.

(Optional) (Required if type is full-structural or plan-set-fs combination and express is true) Numeric.

(Optional) (Required if type is full-structural or plan-set-fs combination and express is true) Numeric.

(Optional) (Required if type is full-structural or plan-set-fs combination and express is true) Numeric.

full_calcs

(Optional) (Required if type is full-structural or plan-set-fs combination and express is true)

Child parameters

(Required).

(Required) Numeric.

(Required).

(Required) Numeric; Max:48

(Required).

(Required).

(Required).

(Required).

`creator_email`

`name`

`client_po`

`description`

`type`

`express`

`sp_file`

`sp_stamp_coordinates`

`sp_stamp_coordinates.stamping_profile_id`

`sp_stamp_coordinates.design_stamping_profile_id`

`sp_stamp_coordinates.x_position`

`sp_stamp_coordinates.y_position`

`sp_stamp_coordinates.pages`

`add_ons`

`add_ons.{index}.name`

`add_ons.{index}.quantity`

(Required if name of addon is `wet-stamp`).

`shipping_profile`

(Required if add-ons include `wet-stamp`). | json

`address`

`project_meta`

(Required if `type` is `iebc-letter or in plan-set-iebc combination`).

(Required if `type` is `iebc-letter or in plan-set-iebc combination`).

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`) Numeric.

`full_calcs`

(Optional) (Required if type is `full-structural or plan-set-fs combination and express is true`)

(Required if `y_position` is present).

(Required if `x_position` is present).