BusinessApi

<back to all web services

GetStaffRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/staff/get
GetStaffRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceIdquerylongNo
GetStaffResponse Parameters:
NameParameterData TypeRequiredDescription
StaffListformList<StaffDto>Yes
StaffDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
FirstNameformstringNo
LastNameformstringNo
EmailformstringNo
RoleformStaffRoleNo
PlaceIdformlong?No
BusinessIdformlong?No
UserIdformlongNo
PlaceNameformstringNo
BusinessNameformstringNo
MobileNumberformstringYes
BusinessRoleformBusinessRoleNo
LastActiveOnformDateTimeOffsetNo
StaffRole Enum:
Owner
Admin
Regular
BusinessRole Enum:
Owner
Manager
Sales
Marketing
Other

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /staff/get HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetStaffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <StaffList>
    <StaffDto>
      <BusinessId>0</BusinessId>
      <BusinessName>String</BusinessName>
      <BusinessRole>Owner</BusinessRole>
      <Email>String</Email>
      <FirstName>String</FirstName>
      <Id>0</Id>
      <LastActiveOn xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </LastActiveOn>
      <LastName>String</LastName>
      <MobileNumber>String</MobileNumber>
      <PlaceId>0</PlaceId>
      <PlaceName>String</PlaceName>
      <Role>Owner</Role>
      <UserId>0</UserId>
    </StaffDto>
  </StaffList>
</GetStaffResponse>