BusinessApi

<back to all web services

InviteStaffRequest

Business
Requires Authentication
Required role:Business
The following routes are available for this service:
POST/staff/invite
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum

# module BusinessApi


class BusinessRole(str, Enum):
    OWNER = 'Owner'
    MANAGER = 'Manager'
    SALES = 'Sales'
    MARKETING = 'Marketing'
    OTHER = 'Other'


Python InviteStaffRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /staff/invite HTTP/1.1 
Host: business-api.brovs.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"userId":0,"placeId":0,"businessId":0,"role":"Owner","businessRole":"Owner"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"staffInvitation":{"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-01T00:00:00.0000000Z","updatedAt":"0001-01-01T00:00:00.0000000Z"},"sentEmailWithRequestId":"String"}