POST api/ApiIntegration/SBApiGetProjectClient

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": "b47ced79-65c6-490d-88b4-e2b7b6206f84",
    "projectName": "sample string 2"
  },
  "client": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "b0ebe512-acbf-4512-bbca-f33fb274c35f",
      "responseNote": "sample string 2"
    },
    "clientKey": "a4b206d4-ae6b-453f-a8ac-c1a6662a982f",
    "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>a4b206d4-ae6b-453f-a8ac-c1a6662a982f</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>b0ebe512-acbf-4512-bbca-f33fb274c35f</ReturnKey>
    </apiResponse>
  </Client>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <ProjectKey>b47ced79-65c6-490d-88b4-e2b7b6206f84</ProjectKey>
    <ProjectName>sample string 2</ProjectName>
  </Project>
</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": "2be3556f-1c6d-4b6e-963e-e47e5de02866",
    "responseNote": "sample string 2"
  },
  "clientInfo": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "2be3556f-1c6d-4b6e-963e-e47e5de02866",
      "responseNote": "sample string 2"
    },
    "clientKey": "bb9301c6-148d-4dee-92ab-0aa9ed9ce7de",
    "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">
  <ClientInfo>
    <City>sample string 8</City>
    <ClientKey>bb9301c6-148d-4dee-92ab-0aa9ed9ce7de</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>2be3556f-1c6d-4b6e-963e-e47e5de02866</ReturnKey>
    </apiResponse>
  </ClientInfo>
  <apiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>2be3556f-1c6d-4b6e-963e-e47e5de02866</ReturnKey>
  </apiResponse>
</ApiClientResponseModel>