BusinessApi

InviteStaffRequest

Business

**Requires Authentication**
Required role:	Business

The following routes are available for this service:
POST	/staff/invite

<?php namespace BusinessApi;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


enum BusinessRole : string
{
    case Owner = 'Owner';
    case Manager = 'Manager';
    case Sales = 'Sales';
    case Marketing = 'Marketing';
    case Other = 'Other';
}

PHP InviteStaffRequest DTOs

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.

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

<InviteStaffRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <BusinessId>0</BusinessId>
  <BusinessRole>Owner</BusinessRole>
  <PlaceId>0</PlaceId>
  <Role>Owner</Role>
  <UserId>0</UserId>
</InviteStaffRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<InviteStaffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessApi.Dto">
  <SentEmailWithRequestId>String</SentEmailWithRequestId>
  <StaffInvitation>
    <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>
  </StaffInvitation>
</InviteStaffResponse>