POST api/ApiIntegration/SBApiGetClientInfo

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrivateApiKey		string	None.
Client		ApiClientInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "client": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "a0387a7a-d569-4cf6-a0c3-2d9cd3c06226",
      "responseNote": "sample string 2",
      "errorString": "sample string 3"
    },
    "clientKey": "f92e5115-c37e-4bfd-be92-2d557993e34b",
    "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:

<ApiGetClientInfo 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>a0387a7a-d569-4cf6-a0c3-2d9cd3c06226</ReturnKey>
    </ApiResponse>
    <City>sample string 8</City>
    <ClientKey>f92e5115-c37e-4bfd-be92-2d557993e34b</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>
</ApiGetClientInfo>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientInfo

Name	Type	Additional information
ApiResponse	ApiResponse	None.
ClientKey	globally unique identifier	None.
ClientName	string	None.
ClientNote	string	None.
ContactName	string	None.
Salutation	string	None.
NoAndStreet	string	None.
Suburb	string	None.
City	string	None.
Phone	string	None.
Mobile	string	None.
Email	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.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "57219e7b-a75a-45ca-89e3-af6d6667f03b",
    "responseNote": "sample string 2",
    "errorString": "sample string 3"
  },
  "clientKey": "ca4c6be6-57be-4469-88b8-a63c4f77e165",
  "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:

<ApiClientInfo 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>57219e7b-a75a-45ca-89e3-af6d6667f03b</ReturnKey>
  </ApiResponse>
  <City>sample string 8</City>
  <ClientKey>ca4c6be6-57be-4469-88b8-a63c4f77e165</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>
</ApiClientInfo>