| POST | /share/refer-business-link-used | A business referral link was used | Validates the JWT token with the identity of the referring user and the place, and returns relevant information. |
|---|
namespace ConsumerApi
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type ReferBusinessUser() =
member val FirstName:String = null with get,set
member val LastName:String = null with get,set
member val ProfilePhotoUrl:String = null with get,set
[<AllowNullLiteral>]
type ReferredPlace() =
member val Id:Int64 = new Int64() with get,set
member val Guid:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val LogoUrl:String = null with get,set
member val ImageUrl:String = null with get,set
type ReferBusinessState =
| SignInToSee = 0
| Available = 1
| CanNotReferYourself = 2
| AlreadyClaimedByYou = 3
| AlreadyClaimedBySomeoneElse = 4
| Expired = 5
[<AllowNullLiteral>]
type ReferBusinessLinkUsedResponse() =
member val ReferringUser:ReferBusinessUser = null with get,set
member val ReferredPlace:ReferredPlace = null with get,set
member val State:ReferBusinessState = new ReferBusinessState() with get,set
[<AllowNullLiteral>]
type ReferBusinessLinkUsedRequest() =
interface IPost
member val ReferBusinessToken:String = null with get,set
F# ReferBusinessLinkUsedRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /share/refer-business-link-used HTTP/1.1
Host: unstable-consumer-api.brovs.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<ReferBusinessLinkUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
<ReferBusinessToken>String</ReferBusinessToken>
</ReferBusinessLinkUsedRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<ReferBusinessLinkUsedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
<ReferredPlace>
<Guid>00000000-0000-0000-0000-000000000000</Guid>
<Id>0</Id>
<ImageUrl>String</ImageUrl>
<LogoUrl>String</LogoUrl>
<Name>String</Name>
</ReferredPlace>
<ReferringUser>
<FirstName>String</FirstName>
<LastName>String</LastName>
<ProfilePhotoUrl>String</ProfilePhotoUrl>
</ReferringUser>
<State>SignInToSee</State>
</ReferBusinessLinkUsedResponse>