POST api/ApiIntegration/SBApiAddProject

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
JobName	string	None.
JobNote1	string	None.
JobNote2	string	None.
JobDate	date	None.
QuoteNumber	string	None.
JobNumber	string	None.
PurchaseOrder	string	None.
Site	ApiSiteInfo	None.
PrivateApiKey	string	None.
ProjectKey	globally unique identifier	None.
ProjectName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "jobName": "sample string 1",
  "jobNote1": "sample string 2",
  "jobNote2": "sample string 3",
  "jobDate": "2026-08-03T21:43:01.2803959+00:00",
  "quoteNumber": "sample string 4",
  "jobNumber": "sample string 5",
  "purchaseOrder": "sample string 6",
  "site": {
    "measureDate": "2026-08-03T21:43:01.2803959+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"
  },
  "privateApiKey": "sample string 7",
  "projectKey": "c9c709c2-bf41-4f90-b27d-833fa4066efd",
  "projectName": "sample string 9"
}

application/xml, text/xml

Sample:

<ApiAddProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 7</PrivateApiKey>
  <ProjectKey>c9c709c2-bf41-4f90-b27d-833fa4066efd</ProjectKey>
  <ProjectName>sample string 9</ProjectName>
  <JobDate>2026-08-03T21:43:01.2803959+00:00</JobDate>
  <JobName>sample string 1</JobName>
  <JobNote1>sample string 2</JobNote1>
  <JobNote2>sample string 3</JobNote2>
  <JobNumber>sample string 5</JobNumber>
  <PurchaseOrder>sample string 6</PurchaseOrder>
  <QuoteNumber>sample string 4</QuoteNumber>
  <Site>
    <City>sample string 4</City>
    <CrossStreet>sample string 6</CrossStreet>
    <MeasureDate>2026-08-03T21:43:01.2803959+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>
</ApiAddProjectParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponseModel

Name	Description	Type	Additional information
ApiResponse		ApiResponse	None.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "496dfc53-da32-41e9-8619-bd58d85d0fa9",
    "responseNote": "sample string 2"
  }
}

application/xml, text/xml

Sample:

<ApiResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>496dfc53-da32-41e9-8619-bd58d85d0fa9</ReturnKey>
  </ApiResponse>
</ApiResponseModel>