ConsumerApi

ReferBusinessLinkUsedRequest

ConsumerBusiness

The following routes are available for this service:
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.

import Foundation
import ServiceStack

public class ReferBusinessLinkUsedRequest : IPost, Codable
{
    public var referBusinessToken:String

    required public init(){}
}

public class ReferBusinessLinkUsedResponse : Codable
{
    public var referringUser:ReferBusinessUser
    public var referredPlace:ReferredPlace
    public var state:ReferBusinessState

    required public init(){}
}

public class ReferBusinessUser : Codable
{
    public var firstName:String
    public var lastName:String
    public var profilePhotoUrl:String

    required public init(){}
}

public class ReferredPlace : Codable
{
    public var id:Int
    public var guid:String
    public var name:String
    public var logoUrl:String
    public var imageUrl:String

    required public init(){}
}

public enum ReferBusinessState : String, Codable
{
    case SignInToSee
    case Available
    case CanNotReferYourself
    case AlreadyClaimedByYou
    case AlreadyClaimedBySomeoneElse
    case Expired
}

Swift ReferBusinessLinkUsedRequest DTOs

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.

POST /share/refer-business-link-used HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	referBusinessToken: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	referringUser: 
	{
		firstName: String,
		lastName: String,
		profilePhotoUrl: String
	},
	referredPlace: 
	{
		id: 0,
		name: String,
		logoUrl: String,
		imageUrl: String
	},
	state: SignInToSee
}