POST api/ApiIntegration/SBApiGetSalesPersons

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
PrivateApiKey		string	None.

Request Formats

application/json, text/json

Sample:

{
  "privateApiKey": "sample string 1"
}

application/xml, text/xml

Sample:

<ApiGetSalesPersonsParam xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/StairBiz.Contracts.ViewModels">
  <PrivateApiKey>sample string 1</PrivateApiKey>
</ApiGetSalesPersonsParam>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiSalesPersonsResponse

Name	Type	Additional information
SalesPersons	Collection of ApiSalesPersonInfo	None.
ResponseCode	integer	None.
ReturnKey	globally unique identifier	None.
ResponseNote	string	None.
ErrorString	string	None.

Response Formats

application/json, text/json

Sample:

{
  "salesPersons": [
    {
      "userUid": "4ec71657-a3a3-4e81-84b9-2470ef63b671",
      "name": "sample string 2"
    },
    {
      "userUid": "4ec71657-a3a3-4e81-84b9-2470ef63b671",
      "name": "sample string 2"
    }
  ],
  "responseCode": 1,
  "returnKey": "add35f5a-0c0e-476c-a268-0324885063df",
  "responseNote": "sample string 2",
  "errorString": "sample string 3"
}

application/xml, text/xml

Sample:

<ApiSalesPersonsResponse 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>add35f5a-0c0e-476c-a268-0324885063df</ReturnKey>
  <SalesPersons>
    <ApiSalesPersonInfo>
      <Name>sample string 2</Name>
      <UserUid>4ec71657-a3a3-4e81-84b9-2470ef63b671</UserUid>
    </ApiSalesPersonInfo>
    <ApiSalesPersonInfo>
      <Name>sample string 2</Name>
      <UserUid>4ec71657-a3a3-4e81-84b9-2470ef63b671</UserUid>
    </ApiSalesPersonInfo>
  </SalesPersons>
</ApiSalesPersonsResponse>