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.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "clientKey": "35d3e896-8d7c-4377-9a73-67bf873ea1be",
  "clientName": "sample string 3"
}

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">
  <ClientKey>35d3e896-8d7c-4377-9a73-67bf873ea1be</ClientKey>
  <ClientName>sample string 3</ClientName>
  <PrivateApiKey>sample string 1</PrivateApiKey>
</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.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "7c2d3e93-a037-479d-ba51-c73fe7181457",
  "errorString": "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">
  <ErrorString>sample string 2</ErrorString>
  <ResponseCode>1</ResponseCode>
  <ReturnKey>7c2d3e93-a037-479d-ba51-c73fe7181457</ReturnKey>
</ApiResponse>