POST api/ApiIntegration/SBApiAddProjectAndClient
Request Information
URI Parameters
None.
Body Parameters
ApiAddProjectAndClientParamName | Description | 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": "6fc25c5b-0cb6-4257-889d-d9e5e00d139c", "projectName": "sample string 3", "clientKey": "f359b059-5fc2-43ea-8264-bff2a6bdba90", "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>f359b059-5fc2-43ea-8264-bff2a6bdba90</ClientKey> <ClientName>sample string 5</ClientName> <PrivateApiKey>sample string 1</PrivateApiKey> <ProjectKey>6fc25c5b-0cb6-4257-889d-d9e5e00d139c</ProjectKey> <ProjectName>sample string 3</ProjectName> </ApiAddProjectAndClientParam>
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": "a53c04e0-4b9b-408f-8998-3061489f07ad", "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>a53c04e0-4b9b-408f-8998-3061489f07ad</ReturnKey> </ApiResponse>