POST api/ApiIntegration/SBApiGetProjectExists

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
Project	ApiProjectInfo	None.
Client	ApiClientInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "project": {
    "projectKey": "093f7393-cc35-448f-b2cf-35e7b1a201e8",
    "projectName": "sample string 2"
  },
  "client": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "d56f11ab-3fb7-4004-892b-c3570ecc8ecc",
      "responseNote": "sample string 2"
    },
    "clientKey": "5ab6bda2-e1d9-4ff4-a163-e2192128ddeb",
    "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:

<ApiProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Client>
    <City>sample string 8</City>
    <ClientKey>5ab6bda2-e1d9-4ff4-a163-e2192128ddeb</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>
    <apiResponse>
      <ResponseCode>1</ResponseCode>
      <ResponseNote>sample string 2</ResponseNote>
      <ReturnKey>d56f11ab-3fb7-4004-892b-c3570ecc8ecc</ReturnKey>
    </apiResponse>
  </Client>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <ProjectKey>093f7393-cc35-448f-b2cf-35e7b1a201e8</ProjectKey>
    <ProjectName>sample string 2</ProjectName>
  </Project>
</ApiProjectParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse

Name	Type	Additional information
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "406f4d9b-7cc4-408d-9290-1e2351a369bc",
  "responseNote": "sample string 2"
}

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">
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>406f4d9b-7cc4-408d-9290-1e2351a369bc</ReturnKey>
</ApiResponse>