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": "66d538fb-2d7c-4416-a3e9-fc5a0e6b1c78",
  "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>66d538fb-2d7c-4416-a3e9-fc5a0e6b1c78</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.
ResponseNote	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "f9fc9ce6-693a-4315-a2d3-6cf47cc6ec55",
  "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>f9fc9ce6-693a-4315-a2d3-6cf47cc6ec55</ReturnKey>
</ApiResponse>