POST api/ApiIntegration/SBApiAddProject

Request Information

URI Parameters

None.

Body Parameters

ApiAddProjectParam
NameDescriptionTypeAdditional information
PrivateApiKey

string

None.

ProjectKey

globally unique identifier

None.

ProjectName

string

None.

Request Formats

application/json, text/json

Sample:
{
  "privateApiKey": "sample string 1",
  "projectKey": "3fc3031e-291f-4e25-83dc-67c939735f89",
  "projectName": "sample string 3"
}

application/xml, text/xml

Sample:
<ApiAddProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <ProjectKey>3fc3031e-291f-4e25-83dc-67c939735f89</ProjectKey>
  <ProjectName>sample string 3</ProjectName>
</ApiAddProjectParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse
NameDescriptionTypeAdditional information
ResponseCode

integer

None.

ReturnKey

globally unique identifier

None.

ResponseNote

string

None.

Response Formats

application/json, text/json

Sample:
{
  "responseCode": 1,
  "returnKey": "21b997d1-40e3-4e5d-a426-a97160e5f730",
  "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>21b997d1-40e3-4e5d-a426-a97160e5f730</ReturnKey>
</ApiResponse>