ConsumerApi

ReferFriendLinkUsedRequest

Consumer

The following routes are available for this service:
POST	/share/refer-friend-link-used	A friend referral link was used	Validates the JWT token with the identity of the referring user and returns relevant information.

import Foundation
import ServiceStack

public class ReferFriendLinkUsedRequest : IPost, Codable
{
    public var referFriendToken:String

    required public init(){}
}

public class ReferFriendLinkUsedResponse : Codable
{
    public var referringUser:ReferFriendUser
    public var state:ReferFriendState

    required public init(){}
}

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

    required public init(){}
}

public enum ReferFriendState : String, Codable
{
    case Available
    case Awarded
    case CanNotReferYourself
    case YouWereAlreadySignedUp
    case Expired
}

Swift ReferFriendLinkUsedRequest 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 /share/refer-friend-link-used HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"referFriendToken":"String"}

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

{"referringUser":{"firstName":"String","lastName":"String","profilePhotoUrl":"String"},"state":"Available"}