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

<ReferFriendLinkUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ReferFriendToken>String</ReferFriendToken>
</ReferFriendLinkUsedRequest>

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

<ReferFriendLinkUsedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ReferringUser>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
  </ReferringUser>
  <State>Available</State>
</ReferFriendLinkUsedResponse>