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.
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports ConsumerApi

Namespace Global

    Namespace ConsumerApi

        Public Partial Class ReferFriendLinkUsedRequest
            Implements IPost
            Public Property ReferFriendToken As String
        End Class

        Public Partial Class ReferFriendLinkUsedResponse
            Public Property ReferringUser As ReferFriendUser
            Public Property State As ReferFriendState
        End Class

        Public Enum ReferFriendState
            Available
            Awarded
            CanNotReferYourself
            YouWereAlreadySignedUp
            Expired
        End Enum

        Public Partial Class ReferFriendUser
            Public Property FirstName As String
            Public Property LastName As String
            Public Property ProfilePhotoUrl As String
        End Class
    End Namespace
End Namespace

VB.NET 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"}