POST api/ApiIntegration/SBApiGetProjectClient

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
PrivateApiKey	string	None.
Project	ApiProjectInfo	None.
Client	ApiClientInfo	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1",
  "project": {
    "projectKey": "6f4452af-6097-448e-9753-b89e1e95da8e",
    "projectName": "sample string 2"
  },
  "client": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "1dd3499f-ed53-4ea7-b475-2a0fd1fc6776",
      "responseNote": "sample string 2"
    },
    "clientKey": "beba6d74-5a9e-44ac-a82b-379f1f3b1626",
    "clientName": "sample string 2",
    "clientNote": "sample string 3",
    "contactName": "sample string 4",
    "salutation": "sample string 5",
    "noAndStreet": "sample string 6",
    "suburb": "sample string 7",
    "city": "sample string 8",
    "phone": "sample string 9",
    "mobile": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<ApiProjectParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <Client>
    <City>sample string 8</City>
    <ClientKey>beba6d74-5a9e-44ac-a82b-379f1f3b1626</ClientKey>
    <ClientName>sample string 2</ClientName>
    <ClientNote>sample string 3</ClientNote>
    <ContactName>sample string 4</ContactName>
    <Mobile>sample string 10</Mobile>
    <NoAndStreet>sample string 6</NoAndStreet>
    <Phone>sample string 9</Phone>
    <Salutation>sample string 5</Salutation>
    <Suburb>sample string 7</Suburb>
    <apiResponse>
      <ResponseCode>1</ResponseCode>
      <ResponseNote>sample string 2</ResponseNote>
      <ReturnKey>1dd3499f-ed53-4ea7-b475-2a0fd1fc6776</ReturnKey>
    </apiResponse>
  </Client>
  <PrivateApiKey>sample string 1</PrivateApiKey>
  <Project>
    <ProjectKey>6f4452af-6097-448e-9753-b89e1e95da8e</ProjectKey>
    <ProjectName>sample string 2</ProjectName>
  </Project>
</ApiProjectParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiClientResponseModel

Name	Description	Type	Additional information
apiResponse		ApiResponse	None.
ClientInfo		ApiClientInfo	None.

Response Formats

application/json, text/json

Sample:

{
  "apiResponse": {
    "responseCode": 1,
    "returnKey": "775bdbec-cedd-4bdb-b1f4-7a14dca0b907",
    "responseNote": "sample string 2"
  },
  "clientInfo": {
    "apiResponse": {
      "responseCode": 1,
      "returnKey": "775bdbec-cedd-4bdb-b1f4-7a14dca0b907",
      "responseNote": "sample string 2"
    },
    "clientKey": "b0ce8e6e-7526-4818-bcc3-af225d04a997",
    "clientName": "sample string 2",
    "clientNote": "sample string 3",
    "contactName": "sample string 4",
    "salutation": "sample string 5",
    "noAndStreet": "sample string 6",
    "suburb": "sample string 7",
    "city": "sample string 8",
    "phone": "sample string 9",
    "mobile": "sample string 10"
  }
}

application/xml, text/xml

Sample:

<ApiClientResponseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <ClientInfo>
    <City>sample string 8</City>
    <ClientKey>b0ce8e6e-7526-4818-bcc3-af225d04a997</ClientKey>
    <ClientName>sample string 2</ClientName>
    <ClientNote>sample string 3</ClientNote>
    <ContactName>sample string 4</ContactName>
    <Mobile>sample string 10</Mobile>
    <NoAndStreet>sample string 6</NoAndStreet>
    <Phone>sample string 9</Phone>
    <Salutation>sample string 5</Salutation>
    <Suburb>sample string 7</Suburb>
    <apiResponse>
      <ResponseCode>1</ResponseCode>
      <ResponseNote>sample string 2</ResponseNote>
      <ReturnKey>775bdbec-cedd-4bdb-b1f4-7a14dca0b907</ReturnKey>
    </apiResponse>
  </ClientInfo>
  <apiResponse>
    <ResponseCode>1</ResponseCode>
    <ResponseNote>sample string 2</ResponseNote>
    <ReturnKey>775bdbec-cedd-4bdb-b1f4-7a14dca0b907</ReturnKey>
  </apiResponse>
</ApiClientResponseModel>