POST api/ApiIntegration/SBApiAddProject
Request Information
URI Parameters
None.
Body Parameters
ApiAddProjectParamName | 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": "a0c25181-9343-408e-a2e0-5d466ca97aec", "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>a0c25181-9343-408e-a2e0-5d466ca97aec</ProjectKey> <ProjectName>sample string 3</ProjectName> </ApiAddProjectParam>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResponseName | Description | Type | Additional information |
---|---|---|---|
ResponseCode | integer |
None. |
|
ReturnKey | globally unique identifier |
None. |
|
ErrorString | string |
None. |
Response Formats
application/json, text/json
Sample:
{ "responseCode": 1, "returnKey": "41444911-1d99-4bc4-bbb1-9b280a0b2529", "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>41444911-1d99-4bc4-bbb1-9b280a0b2529</ReturnKey> </ApiResponse>