POST api/ApiIntegration/SBApiGetProjectClient

Request Information

URI Parameters

None.

Body Parameters

Name	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": "e882e927-ba18-4318-98dd-70a7253317e1",
    "projectName": "sample string 2",
    "jobName": "sample string 3",
    "jobKey": "05049d8c-fd33-433f-b4cd-7eb294931031",
    "jobNote1": "sample string 4",
    "jobNote2": "sample string 5",
    "salesPerson": "sample string 6",
    "jobDate": "2026-09-18T09:31:23.4252956+00:00",
    "quoteNumber": "sample string 7",
    "jobNumber": "sample string 8",
    "po": "sample string 9"
  },
  "client": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "4b05f557-f8cb-41bd-8588-a12593bae774",
      "responseNote": "sample string 2",
      "errorString": "sample string 3"
    },
    "clientKey": "6d4675da-baa9-45b0-a15f-603071273405",
    "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:31:23.4252956+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>4b05f557-f8cb-41bd-8588-a12593bae774</ReturnKey>
    </ApiResponse>
    <City>sample string 8</City>
    <ClientKey>6d4675da-baa9-45b0-a15f-603071273405</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:31:23.4252956+00:00</JobDate>
    <JobKey>05049d8c-fd33-433f-b4cd-7eb294931031</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>e882e927-ba18-4318-98dd-70a7253317e1</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:31:23.4252956+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

ApiClientResponseModel

Name	Description	Type	Additional information
ApiResponse		ApiResponse	None.
ClientInfo		ApiClientInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "714df736-0c6e-4890-ac9f-7e55c2eff935",
    "responseNote": "sample string 2",
    "errorString": "sample string 3"
  },
  "clientInfo": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "714df736-0c6e-4890-ac9f-7e55c2eff935",
      "responseNote": "sample string 2",
      "errorString": "sample string 3"
    },
    "clientKey": "c2d74442-ea05-49cb-8e20-69d908726783",
    "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
  }
}

application/xml, text/xml

Sample:

<ApiClientResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ApiResponse>
    <ErrorString>sample string 3</ErrorString>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>714df736-0c6e-4890-ac9f-7e55c2eff935</ReturnKey>
  </ApiResponse>
  <ClientInfo>
    <ApiResponse>
      <ErrorString>sample string 3</ErrorString>
      <ResponseCode>1</ResponseCode>
      <ResponseNote>sample string 2</ResponseNote>
      <ReturnKey>714df736-0c6e-4890-ac9f-7e55c2eff935</ReturnKey>
    </ApiResponse>
    <City>sample string 8</City>
    <ClientKey>c2d74442-ea05-49cb-8e20-69d908726783</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>
  </ClientInfo>
</ApiClientResponseModel>