POST api/ApiIntegration/SBApiAddProject
Request Information
URI Parameters
None.
Body Parameters
ApiAddProjectParam| Name | Description | Type | Additional information |
|---|---|---|---|
| PrivateApiKey | string |
None. |
|
| ProjectKey | globally unique identifier |
None. |
|
| ProjectName | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"privateApiKey": "sample string 1",
"projectKey": "eb94130c-d086-4685-b042-0604b6f1e0f1",
"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>eb94130c-d086-4685-b042-0604b6f1e0f1</ProjectKey> <ProjectName>sample string 3</ProjectName> </ApiAddProjectParam>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| ResponseCode | integer |
None. |
|
| ReturnKey | globally unique identifier |
None. |
|
| ResponseNote | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"responseCode": 1,
"returnKey": "1613273d-6979-4562-82f0-c9a51ea26c70",
"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>1613273d-6979-4562-82f0-c9a51ea26c70</ReturnKey> </ApiResponse>