GET api/Warranty?warrantyId={warrantyId}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| warrantyId | integer |
Required |
Body Parameters
None.
Response Information
Resource Description
WarrantyResponseModel| Name | Description | Type | Additional information |
|---|---|---|---|
| Country | string |
None. |
|
| JobNumber | string |
None. |
|
| ContactFirstName | string |
None. |
|
| ContactLastName | string |
None. |
|
| Contractor | string |
None. |
|
| ContractorEmail | string |
None. |
|
| BuildingOwner | string |
None. |
|
| Architect | string |
None. |
|
| GeneralContractor | string |
None. |
|
| Ul | string |
None. |
|
| Fm | string |
None. |
|
| Asce | string |
None. |
|
| Local | string |
None. |
|
| WarrantyType | string |
None. |
|
| WarrantyFee | decimal number |
None. |
|
| FieldSquareFeet | integer |
None. |
|
| FlashingSquareFeet | integer |
None. |
|
| VerticalSquareFeet | integer |
None. |
|
| HorizontalSquareFeet | integer |
None. |
|
| OverburdenSquareFeet | integer |
None. |
|
| OtherSquareFeet | integer |
None. |
|
| SquareFeet | decimal number |
None. |
|
| IssuanceDate | date |
None. |
|
| Inspector | string |
None. |
|
| Region | string |
None. |
|
| WarrantyRiders | Collection of WarrantyRiderModel |
None. |
|
| Documents | Collection of DocumentModel |
None. |
|
| Systems | Collection of SystemModel |
None. |
|
| SiteVisits | Collection of SiteVisitModel |
None. |
|
| WarrantyId | integer |
None. |
|
| Number | string |
None. |
|
| ProjectName | string |
None. |
|
| Address | string |
None. |
|
| City | string |
None. |
|
| State | string |
None. |
|
| Zip | string |
None. |
|
| FinalSiteVisitDate | date |
None. |
|
| WarrantyYears | string |
None. |
|
| Status | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"country": "sample string 1",
"jobNumber": "sample string 2",
"contactFirstName": "sample string 3",
"contactLastName": "sample string 4",
"contractor": "sample string 5",
"contractorEmail": "sample string 6",
"buildingOwner": "sample string 7",
"architect": "sample string 8",
"generalContractor": "sample string 9",
"ul": "sample string 10",
"fm": "sample string 11",
"asce": "sample string 12",
"local": "sample string 13",
"warrantyType": "sample string 14",
"warrantyFee": 1.0,
"fieldSquareFeet": 1,
"flashingSquareFeet": 1,
"verticalSquareFeet": 1,
"horizontalSquareFeet": 1,
"overburdenSquareFeet": 1,
"otherSquareFeet": 1,
"squareFeet": 6.0,
"issuanceDate": "2026-02-18T01:04:53.8552944+00:00",
"inspector": "sample string 15",
"region": "sample string 16",
"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:04:53.8552944+00:00",
"url": "http://webapihelppage4.com"
},
{
"category": "sample string 1",
"description": "sample string 2",
"dateUploaded": "2026-02-18T01:04:53.8552944+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"
}
]
}
],
"siteVisits": [
{
"reportNumber": "sample string 1",
"reportType": "sample string 2",
"status": "sample string 3",
"results": "sample string 4",
"date": "2026-02-18T01:04:53.8707599+00:00",
"url": "http://webapihelppage5.com"
},
{
"reportNumber": "sample string 1",
"reportType": "sample string 2",
"status": "sample string 3",
"results": "sample string 4",
"date": "2026-02-18T01:04:53.8707599+00:00",
"url": "http://webapihelppage5.com"
}
],
"warrantyId": 17,
"number": "sample string 18",
"projectName": "sample string 19",
"address": "sample string 20",
"city": "sample string 21",
"state": "sample string 22",
"zip": "sample string 23",
"finalSiteVisitDate": "2026-02-18T01:04:53.8707599+00:00",
"warrantyYears": "sample string 24",
"status": "sample string 25"
}
application/xml, text/xml
Sample:
<WarrantyResponseModel 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 20</Address>
<City>sample string 21</City>
<FinalSiteVisitDate>2026-02-18T01:04:53.8707599+00:00</FinalSiteVisitDate>
<Number>sample string 18</Number>
<ProjectName>sample string 19</ProjectName>
<SquareFeet>6</SquareFeet>
<State>sample string 22</State>
<Status>sample string 25</Status>
<WarrantyId>17</WarrantyId>
<WarrantyYears>sample string 24</WarrantyYears>
<Zip>sample string 23</Zip>
<Architect>sample string 8</Architect>
<Asce>sample string 12</Asce>
<BuildingOwner>sample string 7</BuildingOwner>
<ContactFirstName>sample string 3</ContactFirstName>
<ContactLastName>sample string 4</ContactLastName>
<Contractor>sample string 5</Contractor>
<ContractorEmail>sample string 6</ContractorEmail>
<Country>sample string 1</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:04:53.8552944+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:04:53.8552944+00:00</d2p1:DateUploaded>
<d2p1:Description>sample string 2</d2p1:Description>
<d2p1:Url>http://webapihelppage4.com/</d2p1:Url>
</d2p1:DocumentModel>
</Documents>
<FieldSquareFeet>1</FieldSquareFeet>
<FlashingSquareFeet>1</FlashingSquareFeet>
<Fm>sample string 11</Fm>
<GeneralContractor>sample string 9</GeneralContractor>
<HorizontalSquareFeet>1</HorizontalSquareFeet>
<Inspector>sample string 15</Inspector>
<IssuanceDate>2026-02-18T01:04:53.8552944+00:00</IssuanceDate>
<JobNumber>sample string 2</JobNumber>
<Local>sample string 13</Local>
<OtherSquareFeet>1</OtherSquareFeet>
<OverburdenSquareFeet>1</OverburdenSquareFeet>
<Region>sample string 16</Region>
<SiteVisits xmlns:d2p1="http://schemas.datacontract.org/2004/07/Soprema.Website.ContractorPortal.WebApi.Models">
<d2p1:SiteVisitModel>
<d2p1:Date>2026-02-18T01:04:53.8707599+00:00</d2p1:Date>
<d2p1:ReportNumber>sample string 1</d2p1:ReportNumber>
<d2p1:ReportType>sample string 2</d2p1:ReportType>
<d2p1:Results>sample string 4</d2p1:Results>
<d2p1:Status>sample string 3</d2p1:Status>
<d2p1:Url>http://webapihelppage5.com/</d2p1:Url>
</d2p1:SiteVisitModel>
<d2p1:SiteVisitModel>
<d2p1:Date>2026-02-18T01:04:53.8707599+00:00</d2p1:Date>
<d2p1:ReportNumber>sample string 1</d2p1:ReportNumber>
<d2p1:ReportType>sample string 2</d2p1:ReportType>
<d2p1:Results>sample string 4</d2p1:Results>
<d2p1:Status>sample string 3</d2p1:Status>
<d2p1:Url>http://webapihelppage5.com/</d2p1:Url>
</d2p1:SiteVisitModel>
</SiteVisits>
<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>
<Ul>sample string 10</Ul>
<VerticalSquareFeet>1</VerticalSquareFeet>
<WarrantyFee>1</WarrantyFee>
<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 14</WarrantyType>
</WarrantyResponseModel>