ConsumerApi

<back to all web services

ReferFriendLinkUsedRequest

Consumer
The following routes are available for this service:
POST/share/refer-friend-link-usedA friend referral link was usedValidates the JWT token with the identity of the referring user and returns relevant information.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ReferFriendLinkUsedRequest : IPost
{
    open var referFriendToken:String? = null
}

open class ReferFriendLinkUsedResponse
{
    open var referringUser:ReferFriendUser? = null
    open var state:ReferFriendState? = null
}

open class ReferFriendUser
{
    open var firstName:String? = null
    open var lastName:String? = null
    open var profilePhotoUrl:String? = null
}

enum class ReferFriendState
{
    Available,
    Awarded,
    CanNotReferYourself,
    YouWereAlreadySignedUp,
    Expired,
}

Kotlin ReferFriendLinkUsedRequest DTOs

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

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"referFriendToken":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

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