POST api/ApiIntegration/SBApiAddProjectAndClient

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
ProjectKey	globally unique identifier	None.
ProjectName	string	None.
ClientKey	globally unique identifier	None.
ClientName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "projectKey": "55d20937-6276-4277-bfff-dad8ce3af21b",
  "projectName": "sample string 3",
  "clientKey": "a2f744c7-54d7-4b21-bba9-2441fb1a78cd",
  "clientName": "sample string 5"
}

application/xml, text/xml

Sample:

<ApiAddProjectAndClientParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ClientKey>a2f744c7-54d7-4b21-bba9-2441fb1a78cd</ClientKey>
  <ClientName>sample string 5</ClientName>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <ProjectKey>55d20937-6276-4277-bfff-dad8ce3af21b</ProjectKey>
  <ProjectName>sample string 3</ProjectName>
</ApiAddProjectAndClientParam>

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.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "9a677fc2-f59b-4671-94af-e136eb697bd2",
  "responseNote": "sample string 2",
  "errorString": "sample string 3"
}

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 3</ErrorString>
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>9a677fc2-f59b-4671-94af-e136eb697bd2</ReturnKey>
</ApiResponse>