GET api/Project?projectId={projectId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| projectId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
ProjectResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| ProjectType | string |
None. |
|
| Country | string |
None. |
|
| ContactFirstName | string |
None. |
|
| ContactLastName | string |
None. |
|
| ApprovedContractorName | string |
None. |
|
| ApprovedContractorEmail | string |
None. |
|
| WarrantyType | string |
None. |
|
| BuildingType | string |
None. |
|
| RequestTechnicalLetter | boolean |
None. |
|
| PhaseSection | string |
None. |
|
| EstimatedProjectStartDate | date |
None. |
|
| EstimatedProjectEndDate | date |
None. |
|
| Region | string |
None. |
|
| SalesPerson | string |
None. |
|
| OtherPerformanceRequirements | string |
None. |
|
| FieldSquareFeet | decimal number |
None. |
|
| FlashingSquareFeet | decimal number |
None. |
|
| VerticalSquareFeet | decimal number |
None. |
|
| HorizontalSquareFeet | decimal number |
None. |
|
| OverburdenSquareFeet | decimal number |
None. |
|
| OtherSquareFeet | decimal number |
None. |
|
| TotalSquareFeet | decimal number |
None. |
|
| WarrantyFeeQuoted | decimal number |
None. |
|
| FireClassification | string |
None. |
|
| FmRating | string |
None. |
|
| FmRoofNavNumber | string |
None. |
|
| FmInsured | boolean |
None. |
|
| FmHurricaneRegion | boolean |
None. |
|
| FbcrMaxDesignPressure | string |
None. |
|
| FbcrReportApprovalNumber | string |
None. |
|
| MdrMaxDesignPressure | string |
None. |
|
| MdrReportApprovalNumber | string |
None. |
|
| OwnerCompany | CompanyModel |
None. |
|
| Owner | string |
None. |
|
| OwnerContactFirstName | string |
None. |
|
| OwnerContactLastName | string |
None. |
|
| OwnerCountry | string |
None. |
|
| OwnerAddress | string |
None. |
|
| OwnerCity | string |
None. |
|
| OwnerState | string |
None. |
|
| OwnerZip | string |
None. |
|
| OwnerPhone | string |
None. |
|
| OwnerFax | string |
None. |
|
| OwnerEmail | string |
None. |
|
| ContractorCompany | CompanyModel |
None. |
|
| Contractor | string |
None. |
|
| ContractorContactFirstName | string |
None. |
|
| ContractorContactLastName | string |
None. |
|
| ContractorCountry | string |
None. |
|
| ContractorAddress | string |
None. |
|
| ContractorCity | string |
None. |
|
| ContractorState | string |
None. |
|
| ContractorZip | string |
None. |
|
| ContractorPhone | string |
None. |
|
| ContractorFax | string |
None. |
|
| ContractorEmail | string |
None. |
|
| GeneralContractorCompany | CompanyModel |
None. |
|
| GeneralContractor | string |
None. |
|
| GeneralContractorContactFirstName | string |
None. |
|
| GeneralContractorContactLastName | string |
None. |
|
| GeneralContractorCountry | string |
None. |
|
| GeneralContractorAddress | string |
None. |
|
| GeneralContractorCity | string |
None. |
|
| GeneralContractorState | string |
None. |
|
| GeneralContractorZip | string |
None. |
|
| GeneralContractorPhone | string |
None. |
|
| GeneralContractorFax | string |
None. |
|
| GeneralContractorEmail | string |
None. |
|
| BondingCompany | CompanyModel |
None. |
|
| PurchaseMethod | string |
None. |
|
| PurchaseTotalEstimate | decimal number |
None. |
|
| IsBondingAgent | boolean |
None. |
|
| WarrantyRiders | Collection of WarrantyRiderModel |
None. |
|
| Documents | Collection of DocumentModel |
None. |
|
| Systems | Collection of SystemModel |
None. |
|
| ProjectId | integer |
None. |
|
| Number | string |
None. |
|
| Name | string |
None. |
|
| Status | string |
None. |
|
| DateSubmitted | date |
None. |
|
| WarrantyYears | string |
None. |
|
| Address | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"projectType": "sample string 1",
"country": "sample string 2",
"contactFirstName": "sample string 3",
"contactLastName": "sample string 4",
"approvedContractorName": "sample string 5",
"approvedContractorEmail": "sample string 6",
"warrantyType": "sample string 7",
"buildingType": "sample string 8",
"requestTechnicalLetter": true,
"phaseSection": "sample string 10",
"estimatedProjectStartDate": "2026-02-18T01:05:03.2693378+00:00",
"estimatedProjectEndDate": "2026-02-18T01:05:03.2693378+00:00",
"region": "sample string 11",
"salesPerson": "sample string 12",
"otherPerformanceRequirements": "sample string 13",
"fieldSquareFeet": 1.1,
"flashingSquareFeet": 1.1,
"verticalSquareFeet": 1.1,
"horizontalSquareFeet": 1.1,
"overburdenSquareFeet": 1.1,
"otherSquareFeet": 1.1,
"totalSquareFeet": 6.6,
"warrantyFeeQuoted": 1.0,
"fireClassification": "sample string 14",
"fmRating": "sample string 15",
"fmRoofNavNumber": "sample string 16",
"fmInsured": true,
"fmHurricaneRegion": true,
"fbcrMaxDesignPressure": "sample string 17",
"fbcrReportApprovalNumber": "sample string 18",
"mdrMaxDesignPressure": "sample string 19",
"mdrReportApprovalNumber": "sample string 20",
"ownerCompany": {
"name": "sample string 1",
"contactFirstName": "sample string 2",
"contactLastName": "sample string 3",
"country": "sample string 4",
"address": "sample string 5",
"city": "sample string 6",
"state": "sample string 7",
"zip": "sample string 8",
"phone": "sample string 9",
"fax": "sample string 10",
"email": "sample string 11"
},
"owner": "sample string 21",
"ownerContactFirstName": "sample string 22",
"ownerContactLastName": "sample string 23",
"ownerCountry": "sample string 24",
"ownerAddress": "sample string 25",
"ownerCity": "sample string 26",
"ownerState": "sample string 27",
"ownerZip": "sample string 28",
"ownerPhone": "sample string 29",
"ownerFax": "sample string 30",
"ownerEmail": "sample string 31",
"contractorCompany": {
"name": "sample string 1",
"contactFirstName": "sample string 2",
"contactLastName": "sample string 3",
"country": "sample string 4",
"address": "sample string 5",
"city": "sample string 6",
"state": "sample string 7",
"zip": "sample string 8",
"phone": "sample string 9",
"fax": "sample string 10",
"email": "sample string 11"
},
"contractor": "sample string 32",
"contractorContactFirstName": "sample string 33",
"contractorContactLastName": "sample string 34",
"contractorCountry": "sample string 35",
"contractorAddress": "sample string 36",
"contractorCity": "sample string 37",
"contractorState": "sample string 38",
"contractorZip": "sample string 39",
"contractorPhone": "sample string 40",
"contractorFax": "sample string 41",
"contractorEmail": "sample string 42",
"generalContractorCompany": {
"name": "sample string 1",
"contactFirstName": "sample string 2",
"contactLastName": "sample string 3",
"country": "sample string 4",
"address": "sample string 5",
"city": "sample string 6",
"state": "sample string 7",
"zip": "sample string 8",
"phone": "sample string 9",
"fax": "sample string 10",
"email": "sample string 11"
},
"generalContractor": "sample string 43",
"generalContractorContactFirstName": "sample string 44",
"generalContractorContactLastName": "sample string 45",
"generalContractorCountry": "sample string 46",
"generalContractorAddress": "sample string 47",
"generalContractorCity": "sample string 48",
"generalContractorState": "sample string 49",
"generalContractorZip": "sample string 50",
"generalContractorPhone": "sample string 51",
"generalContractorFax": "sample string 52",
"generalContractorEmail": "sample string 53",
"bondingCompany": {
"name": "sample string 1",
"contactFirstName": "sample string 2",
"contactLastName": "sample string 3",
"country": "sample string 4",
"address": "sample string 5",
"city": "sample string 6",
"state": "sample string 7",
"zip": "sample string 8",
"phone": "sample string 9",
"fax": "sample string 10",
"email": "sample string 11"
},
"purchaseMethod": "sample string 54",
"purchaseTotalEstimate": 1.1,
"isBondingAgent": true,
"warrantyRiders": [
{
"name": "sample string 1",
"mph": 1,
"request": "sample string 2",
"fee": 1.0
},
{
"name": "sample string 1",
"mph": 1,
"request": "sample string 2",
"fee": 1.0
}
],
"documents": [
{
"category": "sample string 1",
"description": "sample string 2",
"dateUploaded": "2026-02-18T01:05:03.2693378+00:00",
"url": "http://webapihelppage4.com"
},
{
"category": "sample string 1",
"description": "sample string 2",
"dateUploaded": "2026-02-18T01:05:03.2693378+00:00",
"url": "http://webapihelppage4.com"
}
],
"systems": [
{
"projectType": "sample string 1",
"name": "sample string 2",
"structuralDeckType": "sample string 3",
"roofSlope": "sample string 4",
"additionalStructuralDeckInformation": "sample string 5",
"additionalSystemDeckInformation": "sample string 6",
"fieldLayers": [
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
},
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
}
],
"flashingLayers": [
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
},
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
}
]
},
{
"projectType": "sample string 1",
"name": "sample string 2",
"structuralDeckType": "sample string 3",
"roofSlope": "sample string 4",
"additionalStructuralDeckInformation": "sample string 5",
"additionalSystemDeckInformation": "sample string 6",
"fieldLayers": [
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
},
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
}
],
"flashingLayers": [
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
},
{
"sequence": 1,
"component": "sample string 2",
"group": "sample string 3",
"securement": "sample string 4"
}
]
}
],
"projectId": 55,
"number": "sample string 56",
"name": "sample string 57",
"status": "sample string 58",
"dateSubmitted": "2026-02-18T01:05:03.2693378+00:00",
"warrantyYears": "sample string 60",
"address": "sample string 61",
"city": "sample string 62",
"state": "sample string 63",
"zip": "sample string 64"
}
application/xml, text/xml
Sample:
<ProjectResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Soprema.Website.ContractorPortal.WebApi.Models.ResponseModels">
<Address>sample string 61</Address>
<City>sample string 62</City>
<DateSubmitted>2026-02-18T01:05:03.2693378+00:00</DateSubmitted>
<Name>sample string 57</Name>
<Number>sample string 56</Number>
<ProjectId>55</ProjectId>
<State>sample string 63</State>
<Status>sample string 58</Status>
<TotalSquareFeet>6.6</TotalSquareFeet>
<WarrantyYears>sample string 60</WarrantyYears>
<Zip>sample string 64</Zip>
<ApprovedContractorEmail>sample string 6</ApprovedContractorEmail>
<ApprovedContractorName>sample string 5</ApprovedContractorName>
<BondingCompany>
<Address>sample string 5</Address>
<City>sample string 6</City>
<ContactFirstName>sample string 2</ContactFirstName>
<ContactLastName>sample string 3</ContactLastName>
<Country>sample string 4</Country>
<Email>sample string 11</Email>
<Fax>sample string 10</Fax>
<Name>sample string 1</Name>
<Phone>sample string 9</Phone>
<State>sample string 7</State>
<Zip>sample string 8</Zip>
</BondingCompany>
<BuildingType>sample string 8</BuildingType>
<ContactFirstName>sample string 3</ContactFirstName>
<ContactLastName>sample string 4</ContactLastName>
<Contractor>sample string 32</Contractor>
<ContractorAddress>sample string 36</ContractorAddress>
<ContractorCity>sample string 37</ContractorCity>
<ContractorCompany>
<Address>sample string 5</Address>
<City>sample string 6</City>
<ContactFirstName>sample string 2</ContactFirstName>
<ContactLastName>sample string 3</ContactLastName>
<Country>sample string 4</Country>
<Email>sample string 11</Email>
<Fax>sample string 10</Fax>
<Name>sample string 1</Name>
<Phone>sample string 9</Phone>
<State>sample string 7</State>
<Zip>sample string 8</Zip>
</ContractorCompany>
<ContractorContactFirstName>sample string 33</ContractorContactFirstName>
<ContractorContactLastName>sample string 34</ContractorContactLastName>
<ContractorCountry>sample string 35</ContractorCountry>
<ContractorEmail>sample string 42</ContractorEmail>
<ContractorFax>sample string 41</ContractorFax>
<ContractorPhone>sample string 40</ContractorPhone>
<ContractorState>sample string 38</ContractorState>
<ContractorZip>sample string 39</ContractorZip>
<Country>sample string 2</Country>
<Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/Soprema.Website.ContractorPortal.WebApi.Models">
<d2p1:DocumentModel>
<d2p1:Category>sample string 1</d2p1:Category>
<d2p1:DateUploaded>2026-02-18T01:05:03.2693378+00:00</d2p1:DateUploaded>
<d2p1:Description>sample string 2</d2p1:Description>
<d2p1:Url>http://webapihelppage4.com/</d2p1:Url>
</d2p1:DocumentModel>
<d2p1:DocumentModel>
<d2p1:Category>sample string 1</d2p1:Category>
<d2p1:DateUploaded>2026-02-18T01:05:03.2693378+00:00</d2p1:DateUploaded>
<d2p1:Description>sample string 2</d2p1:Description>
<d2p1:Url>http://webapihelppage4.com/</d2p1:Url>
</d2p1:DocumentModel>
</Documents>
<EstimatedProjectEndDate>2026-02-18T01:05:03.2693378+00:00</EstimatedProjectEndDate>
<EstimatedProjectStartDate>2026-02-18T01:05:03.2693378+00:00</EstimatedProjectStartDate>
<FbcrMaxDesignPressure>sample string 17</FbcrMaxDesignPressure>
<FbcrReportApprovalNumber>sample string 18</FbcrReportApprovalNumber>
<FieldSquareFeet>1.1</FieldSquareFeet>
<FireClassification>sample string 14</FireClassification>
<FlashingSquareFeet>1.1</FlashingSquareFeet>
<FmHurricaneRegion>true</FmHurricaneRegion>
<FmInsured>true</FmInsured>
<FmRating>sample string 15</FmRating>
<FmRoofNavNumber>sample string 16</FmRoofNavNumber>
<GeneralContractor>sample string 43</GeneralContractor>
<GeneralContractorAddress>sample string 47</GeneralContractorAddress>
<GeneralContractorCity>sample string 48</GeneralContractorCity>
<GeneralContractorCompany>
<Address>sample string 5</Address>
<City>sample string 6</City>
<ContactFirstName>sample string 2</ContactFirstName>
<ContactLastName>sample string 3</ContactLastName>
<Country>sample string 4</Country>
<Email>sample string 11</Email>
<Fax>sample string 10</Fax>
<Name>sample string 1</Name>
<Phone>sample string 9</Phone>
<State>sample string 7</State>
<Zip>sample string 8</Zip>
</GeneralContractorCompany>
<GeneralContractorContactFirstName>sample string 44</GeneralContractorContactFirstName>
<GeneralContractorContactLastName>sample string 45</GeneralContractorContactLastName>
<GeneralContractorCountry>sample string 46</GeneralContractorCountry>
<GeneralContractorEmail>sample string 53</GeneralContractorEmail>
<GeneralContractorFax>sample string 52</GeneralContractorFax>
<GeneralContractorPhone>sample string 51</GeneralContractorPhone>
<GeneralContractorState>sample string 49</GeneralContractorState>
<GeneralContractorZip>sample string 50</GeneralContractorZip>
<HorizontalSquareFeet>1.1</HorizontalSquareFeet>
<IsBondingAgent>true</IsBondingAgent>
<MdrMaxDesignPressure>sample string 19</MdrMaxDesignPressure>
<MdrReportApprovalNumber>sample string 20</MdrReportApprovalNumber>
<OtherPerformanceRequirements>sample string 13</OtherPerformanceRequirements>
<OtherSquareFeet>1.1</OtherSquareFeet>
<OverburdenSquareFeet>1.1</OverburdenSquareFeet>
<Owner>sample string 21</Owner>
<OwnerAddress>sample string 25</OwnerAddress>
<OwnerCity>sample string 26</OwnerCity>
<OwnerCompany>
<Address>sample string 5</Address>
<City>sample string 6</City>
<ContactFirstName>sample string 2</ContactFirstName>
<ContactLastName>sample string 3</ContactLastName>
<Country>sample string 4</Country>
<Email>sample string 11</Email>
<Fax>sample string 10</Fax>
<Name>sample string 1</Name>
<Phone>sample string 9</Phone>
<State>sample string 7</State>
<Zip>sample string 8</Zip>
</OwnerCompany>
<OwnerContactFirstName>sample string 22</OwnerContactFirstName>
<OwnerContactLastName>sample string 23</OwnerContactLastName>
<OwnerCountry>sample string 24</OwnerCountry>
<OwnerEmail>sample string 31</OwnerEmail>
<OwnerFax>sample string 30</OwnerFax>
<OwnerPhone>sample string 29</OwnerPhone>
<OwnerState>sample string 27</OwnerState>
<OwnerZip>sample string 28</OwnerZip>
<PhaseSection>sample string 10</PhaseSection>
<ProjectType>sample string 1</ProjectType>
<PurchaseMethod>sample string 54</PurchaseMethod>
<PurchaseTotalEstimate>1.1</PurchaseTotalEstimate>
<Region>sample string 11</Region>
<RequestTechnicalLetter>true</RequestTechnicalLetter>
<SalesPerson>sample string 12</SalesPerson>
<Systems xmlns:d2p1="http://schemas.datacontract.org/2004/07/Soprema.Website.ContractorPortal.WebApi.Models">
<d2p1:SystemModel>
<d2p1:AdditionalStructuralDeckInformation>sample string 5</d2p1:AdditionalStructuralDeckInformation>
<d2p1:AdditionalSystemDeckInformation>sample string 6</d2p1:AdditionalSystemDeckInformation>
<d2p1:FieldLayers>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
</d2p1:FieldLayers>
<d2p1:FlashingLayers>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
</d2p1:FlashingLayers>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:ProjectType>sample string 1</d2p1:ProjectType>
<d2p1:RoofSlope>sample string 4</d2p1:RoofSlope>
<d2p1:StructuralDeckType>sample string 3</d2p1:StructuralDeckType>
</d2p1:SystemModel>
<d2p1:SystemModel>
<d2p1:AdditionalStructuralDeckInformation>sample string 5</d2p1:AdditionalStructuralDeckInformation>
<d2p1:AdditionalSystemDeckInformation>sample string 6</d2p1:AdditionalSystemDeckInformation>
<d2p1:FieldLayers>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
</d2p1:FieldLayers>
<d2p1:FlashingLayers>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
<d2p1:LayerModel>
<d2p1:Component>sample string 2</d2p1:Component>
<d2p1:Group>sample string 3</d2p1:Group>
<d2p1:Securement>sample string 4</d2p1:Securement>
<d2p1:Sequence>1</d2p1:Sequence>
</d2p1:LayerModel>
</d2p1:FlashingLayers>
<d2p1:Name>sample string 2</d2p1:Name>
<d2p1:ProjectType>sample string 1</d2p1:ProjectType>
<d2p1:RoofSlope>sample string 4</d2p1:RoofSlope>
<d2p1:StructuralDeckType>sample string 3</d2p1:StructuralDeckType>
</d2p1:SystemModel>
</Systems>
<VerticalSquareFeet>1.1</VerticalSquareFeet>
<WarrantyFeeQuoted>1</WarrantyFeeQuoted>
<WarrantyRiders xmlns:d2p1="http://schemas.datacontract.org/2004/07/Soprema.Website.ContractorPortal.WebApi.Models">
<d2p1:WarrantyRiderModel>
<d2p1:Fee>1</d2p1:Fee>
<d2p1:Mph>1</d2p1:Mph>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Request>sample string 2</d2p1:Request>
</d2p1:WarrantyRiderModel>
<d2p1:WarrantyRiderModel>
<d2p1:Fee>1</d2p1:Fee>
<d2p1:Mph>1</d2p1:Mph>
<d2p1:Name>sample string 1</d2p1:Name>
<d2p1:Request>sample string 2</d2p1:Request>
</d2p1:WarrantyRiderModel>
</WarrantyRiders>
<WarrantyType>sample string 7</WarrantyType>
</ProjectResponseModel>