ConsumerApi

<back to all web services

ReferBusinessLinkUsedRequest

ConsumerBusiness
The following routes are available for this service:
POST/share/refer-business-link-usedA business referral link was usedValidates the JWT token with the identity of the referring user and the place, 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 ReferBusinessLinkUsedRequest
            Implements IPost
            Public Property ReferBusinessToken As String
        End Class

        Public Partial Class ReferBusinessLinkUsedResponse
            Public Property ReferringUser As ReferBusinessUser
            Public Property ReferredPlace As ReferredPlace
            Public Property State As ReferBusinessState
        End Class

        Public Enum ReferBusinessState
            SignInToSee
            Available
            CanNotReferYourself
            AlreadyClaimedByYou
            AlreadyClaimedBySomeoneElse
            Expired
        End Enum

        Public Partial Class ReferBusinessUser
            Public Property FirstName As String
            Public Property LastName As String
            Public Property ProfilePhotoUrl As String
        End Class

        Public Partial Class ReferredPlace
            Public Property Id As Long
            Public Property Guid As Guid
            Public Property Name As String
            Public Property LogoUrl As String
            Public Property ImageUrl As String
        End Class
    End Namespace
End Namespace

VB.NET ReferBusinessLinkUsedRequest 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-business-link-used HTTP/1.1 
Host: unstable-consumer-api.brovs.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"referBusinessToken":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

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