POST api/ApiIntegration/SBApiUpsertProject
Request Information
URI Parameters
None.
Body Parameters
ApiProjectParam| Name | Description | Type | Additional information |
|---|---|---|---|
| PrivateApiKey | string |
None. |
|
| Project | ApiProjectInfo |
None. |
|
| Client | ApiClientInfo |
None. |
|
| Site | ApiSiteInfo |
None. |
Request Formats
application/json, text/json
Sample:
{
"privateApiKey": "sample string 1",
"project": {
"projectKey": "fb650135-3c1c-4851-bf82-8fd973a05d1f",
"projectName": "sample string 2",
"jobName": "sample string 3",
"jobKey": "4c8add42-e2ce-41c3-956a-801168e9000f",
"jobNote1": "sample string 4",
"jobNote2": "sample string 5",
"salesPerson": "sample string 6",
"jobDate": "2026-09-18T09:29:55.9780356+00:00",
"quoteNumber": "sample string 7",
"jobNumber": "sample string 8",
"po": "sample string 9"
},
"client": {
"apiResponse": {
"responseCode": 1,
"returnKey": "8df538dc-a762-41fa-8ed3-a05dc8c2527e",
"responseNote": "sample string 2",
"errorString": "sample string 3"
},
"clientKey": "26683e55-bc3c-4283-a929-c14eb4cc8af2",
"clientName": "sample string 2",
"clientNote": "sample string 3",
"contactName": "sample string 4",
"salutation": "sample string 5",
"noAndStreet": "sample string 6",
"suburb": "sample string 7",
"city": "sample string 8",
"phone": "sample string 9",
"mobile": "sample string 10",
"email": "sample string 11",
"criticalNote": "sample string 12",
"showCritical": true,
"isOwner": true,
"pay1Percent": 15,
"pay2Percent": 16,
"pay2Days": 17,
"terms2": 18,
"pay3Days": 19,
"terms3": 20,
"discount": 21
},
"site": {
"measureDate": "2026-09-18T09:29:55.9894465+00:00",
"siteContact": "sample string 1",
"street": "sample string 2",
"suburb": "sample string 3",
"city": "sample string 4",
"state": "sample string 5",
"crossStreet": "sample string 6",
"phone": "sample string 7",
"newHome": true,
"siteNoteOne": "sample string 9",
"mobile": "sample string 10",
"siteNoteTwo": "sample string 11",
"zip": "sample string 12",
"measureTime": "00:00:00.1234567",
"siteEmail": "sample string 13"
}
}
application/xml, text/xml
Sample:
<ApiProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
<Client>
<ApiResponse>
<ErrorString>sample string 3</ErrorString>
<ResponseCode>1</ResponseCode>
<ResponseNote>sample string 2</ResponseNote>
<ReturnKey>8df538dc-a762-41fa-8ed3-a05dc8c2527e</ReturnKey>
</ApiResponse>
<City>sample string 8</City>
<ClientKey>26683e55-bc3c-4283-a929-c14eb4cc8af2</ClientKey>
<ClientName>sample string 2</ClientName>
<ClientNote>sample string 3</ClientNote>
<ContactName>sample string 4</ContactName>
<CriticalNote>sample string 12</CriticalNote>
<Discount>21</Discount>
<Email>sample string 11</Email>
<IsOwner>true</IsOwner>
<Mobile>sample string 10</Mobile>
<NoAndStreet>sample string 6</NoAndStreet>
<Pay1Percent>15</Pay1Percent>
<Pay2Days>17</Pay2Days>
<Pay2Percent>16</Pay2Percent>
<Pay3Days>19</Pay3Days>
<Phone>sample string 9</Phone>
<Salutation>sample string 5</Salutation>
<ShowCritical>true</ShowCritical>
<Suburb>sample string 7</Suburb>
<Terms2>18</Terms2>
<Terms3>20</Terms3>
</Client>
<PrivateApiKey>sample string 1</PrivateApiKey>
<Project>
<JobDate>2026-09-18T09:29:55.9780356+00:00</JobDate>
<JobKey>4c8add42-e2ce-41c3-956a-801168e9000f</JobKey>
<JobName>sample string 3</JobName>
<JobNote1>sample string 4</JobNote1>
<JobNote2>sample string 5</JobNote2>
<JobNumber>sample string 8</JobNumber>
<PO>sample string 9</PO>
<ProjectKey>fb650135-3c1c-4851-bf82-8fd973a05d1f</ProjectKey>
<ProjectName>sample string 2</ProjectName>
<QuoteNumber>sample string 7</QuoteNumber>
<SalesPerson>sample string 6</SalesPerson>
</Project>
<Site>
<City>sample string 4</City>
<CrossStreet>sample string 6</CrossStreet>
<MeasureDate>2026-09-18T09:29:55.9894465+00:00</MeasureDate>
<MeasureTime>PT0.1234567S</MeasureTime>
<Mobile>sample string 10</Mobile>
<NewHome>true</NewHome>
<Phone>sample string 7</Phone>
<SiteContact>sample string 1</SiteContact>
<SiteEmail>sample string 13</SiteEmail>
<SiteNoteOne>sample string 9</SiteNoteOne>
<SiteNoteTwo>sample string 11</SiteNoteTwo>
<State>sample string 5</State>
<Street>sample string 2</Street>
<Suburb>sample string 3</Suburb>
<Zip>sample string 12</Zip>
</Site>
</ApiProjectParam>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseCode | integer |
None. |
|
| ReturnKey | globally unique identifier |
None. |
|
| ResponseNote | string |
None. |
|
| ErrorString | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"responseCode": 1,
"returnKey": "1c553b53-5767-4973-a468-172defa9ad26",
"responseNote": "sample string 2",
"errorString": "sample string 3"
}
application/xml, text/xml
Sample:
<ApiResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels"> <ErrorString>sample string 3</ErrorString> <ResponseCode>1</ResponseCode> <ResponseNote>sample string 2</ResponseNote> <ReturnKey>1c553b53-5767-4973-a468-172defa9ad26</ReturnKey> </ApiResponse>