POST api/ApiIntegration/SBApiUpdateClient

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": "ace372d0-ad8c-451b-a239-5a1f97ac85a1",
      "responseNote": "sample string 2"
    },
    "clientKey": "2ff20823-95bd-4aa1-b2ea-29a9e4196293",
    "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>
    <City>sample string 8</City>
    <ClientKey>2ff20823-95bd-4aa1-b2ea-29a9e4196293</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>ace372d0-ad8c-451b-a239-5a1f97ac85a1</ReturnKey>
    </apiResponse>
  </Client>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiGetClientInfo>

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": "17c3b965-1191-4156-9f03-85d3e76942d1",
  "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>17c3b965-1191-4156-9f03-85d3e76942d1</ReturnKey>
</ApiResponse>