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": "919b2c18-9af9-4a8d-8437-3b81c5b91709",
"projectName": "sample string 3",
"clientKey": "4527b9c9-66fd-49fb-95c2-6b3c3d2da0f9",
"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>4527b9c9-66fd-49fb-95c2-6b3c3d2da0f9</ClientKey> <ClientName>sample string 5</ClientName> <PrivateApiKey>sample string 1</PrivateApiKey> <ProjectKey>919b2c18-9af9-4a8d-8437-3b81c5b91709</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": "eb631427-67ac-4a66-a2df-ecc2c246c18d",
"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>eb631427-67ac-4a66-a2df-ecc2c246c18d</ReturnKey> </ApiResponse>