POST api/ApiIntegration/SBApiAddProjectAndClient
Request Information
URI Parameters
None.
Body Parameters
ApiAddProjectAndClientParam| Name | 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": "61192a30-4b87-48fe-b7ec-4b7a5086f7be",
"projectName": "sample string 3",
"clientKey": "4d329fd6-7755-4a0c-a5ec-0a2770c2596e",
"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>4d329fd6-7755-4a0c-a5ec-0a2770c2596e</ClientKey> <ClientName>sample string 5</ClientName> <PrivateApiKey>sample string 1</PrivateApiKey> <ProjectKey>61192a30-4b87-48fe-b7ec-4b7a5086f7be</ProjectKey> <ProjectName>sample string 3</ProjectName> </ApiAddProjectAndClientParam>
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": "065f8fa4-b1c0-465e-8839-ab2c33df91e4",
"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>065f8fa4-b1c0-465e-8839-ab2c33df91e4</ReturnKey> </ApiResponse>