POST api/ApiIntegration/SBApiAddClient

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
ClientKey	globally unique identifier	None.
ClientName	string	None.
ContactName	string	None.
Salutation	string	None.
Street	string	None.
Suburb	string	None.
City	string	None.
State	string	None.
Zip	string	None.
ReferredBy	string	None.
Phone	string	None.
Fax	string	None.
Mobile	string	None.
Email	string	None.
ClientNote	string	None.
CriticalNote	string	None.
ShowCritical	boolean	None.
IsOwner	boolean	None.
Pay1Percent	integer	None.
Pay2Percent	integer	None.
Pay2Days	integer	None.
Terms2	integer	None.
Pay3Days	integer	None.
Terms3	integer	None.
Discount	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "clientKey": "52e08b1b-18a5-42d0-b364-1f2dadf38c1b",
  "clientName": "sample string 3",
  "contactName": "sample string 4",
  "salutation": "sample string 5",
  "street": "sample string 6",
  "suburb": "sample string 7",
  "city": "sample string 8",
  "state": "sample string 9",
  "zip": "sample string 10",
  "referredBy": "sample string 11",
  "phone": "sample string 12",
  "fax": "sample string 13",
  "mobile": "sample string 14",
  "email": "sample string 15",
  "clientNote": "sample string 16",
  "criticalNote": "sample string 17",
  "showCritical": true,
  "isOwner": true,
  "pay1Percent": 20,
  "pay2Percent": 21,
  "pay2Days": 22,
  "terms2": 23,
  "pay3Days": 24,
  "terms3": 25,
  "discount": 26
}

application/xml, text/xml

Sample:

<ApiAddClientParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <City>sample string 8</City>
  <ClientKey>52e08b1b-18a5-42d0-b364-1f2dadf38c1b</ClientKey>
  <ClientName>sample string 3</ClientName>
  <ClientNote>sample string 16</ClientNote>
  <ContactName>sample string 4</ContactName>
  <CriticalNote>sample string 17</CriticalNote>
  <Discount>26</Discount>
  <Email>sample string 15</Email>
  <Fax>sample string 13</Fax>
  <IsOwner>true</IsOwner>
  <Mobile>sample string 14</Mobile>
  <Pay1Percent>20</Pay1Percent>
  <Pay2Days>22</Pay2Days>
  <Pay2Percent>21</Pay2Percent>
  <Pay3Days>24</Pay3Days>
  <Phone>sample string 12</Phone>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <ReferredBy>sample string 11</ReferredBy>
  <Salutation>sample string 5</Salutation>
  <ShowCritical>true</ShowCritical>
  <State>sample string 9</State>
  <Street>sample string 6</Street>
  <Suburb>sample string 7</Suburb>
  <Terms2>23</Terms2>
  <Terms3>25</Terms3>
  <Zip>sample string 10</Zip>
</ApiAddClientParam>

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": "3d89a69e-200f-494d-ab63-0eae5c587ebb",
  "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>3d89a69e-200f-494d-ab63-0eae5c587ebb</ReturnKey>
</ApiResponse>