BusinessApi

<back to all web services

PendingStaffInvitationsRequest

Business
Requires Authentication
Required role:Consumer
The following routes are available for this service:
GET/staff/pending_invitations
PendingStaffInvitationsResponse Parameters:
NameParameterData TypeRequiredDescription
InvitationsformList<StaffInvitationDto>Yes
StaffInvitationDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
UserIdformlong?No
PlaceIdformlong?No
PlaceGuidformGuid?No
InviteKeyformstringYes
BusinessIdformlong?No
FirstNameformstringNo
LastNameformstringNo
PlaceNameformstringNo
BusinessNameformstringNo
RoleformStaffRoleNo
BusinessRoleformBusinessRoleNo
CreatedAtformDateTimeNo
UpdatedAtformDateTimeNo
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/pending_invitations HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PendingStaffInvitationsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <Invitations>
    <StaffInvitationDto>
      <BusinessId>0</BusinessId>
      <BusinessName>String</BusinessName>
      <BusinessRole>Owner</BusinessRole>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <FirstName>String</FirstName>
      <Id>0</Id>
      <InviteKey>String</InviteKey>
      <LastName>String</LastName>
      <PlaceGuid>00000000-0000-0000-0000-000000000000</PlaceGuid>
      <PlaceId>0</PlaceId>
      <PlaceName>String</PlaceName>
      <Role>Owner</Role>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <UserId>0</UserId>
    </StaffInvitationDto>
  </Invitations>
</PendingStaffInvitationsResponse>