POST api/ApiIntegration/TryConnectToDynamics

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrivateApiKey		string	None.
Project		ApiProjectModel	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "project": {
    "privateApiKey": "sample string 1",
    "projectKey": "b7c5436c-0fb2-4042-91f1-6054ee7c0a0f",
    "projectName": "sample string 3"
  }
}

application/xml, text/xml

Sample:

<ApiGetProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <PrivateApiKey>sample string 1</PrivateApiKey>
    <ProjectKey>b7c5436c-0fb2-4042-91f1-6054ee7c0a0f</ProjectKey>
    <ProjectName>sample string 3</ProjectName>
  </Project>
</ApiGetProjectParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResponse

Name	Type	Additional information
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "responseCode": 1,
  "returnKey": "8720befe-0fc8-4bb4-a6cb-b9060981354f",
  "responseNote": "sample string 2",
  "errorString": "sample string 3"
}

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 3</ErrorString>
  <ResponseCode>1</ResponseCode>
  <ResponseNote>sample string 2</ResponseNote>
  <ReturnKey>8720befe-0fc8-4bb4-a6cb-b9060981354f</ReturnKey>
</ApiResponse>