BusinessApi

<back to all web services

GetStaffInvitationsRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
GET/staff/get_invitations
GetStaffInvitationsRequest Parameters:
NameParameterData TypeRequiredDescription
PlaceIdsqueryList<long>Yes
GetStaffInvitationsResponse 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 .jsv suffix or ?format=jsv

HTTP + JSV

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

GET /staff/get_invitations HTTP/1.1 
Host: business-api.brovs.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	invitations: 
	[
		{
			id: 0,
			userId: 0,
			placeId: 0,
			placeGuid: 00000000-0000-0000-0000-000000000000,
			inviteKey: String,
			businessId: 0,
			firstName: String,
			lastName: String,
			placeName: String,
			businessName: String,
			role: Owner,
			businessRole: Owner,
			createdAt: 0001-01-01,
			updatedAt: 0001-01-01
		}
	]
}