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.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class ReferBusinessLinkUsedRequest : IPost
{
    open var referBusinessToken:String? = null
}

open class ReferBusinessLinkUsedResponse
{
    open var referringUser:ReferBusinessUser? = null
    open var referredPlace:ReferredPlace? = null
    open var state:ReferBusinessState? = null
}

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

open class ReferredPlace
{
    open var id:Long? = null
    open var guid:UUID? = null
    open var name:String? = null
    open var logoUrl:String? = null
    open var imageUrl:String? = null
}

enum class ReferBusinessState
{
    SignInToSee,
    Available,
    CanNotReferYourself,
    AlreadyClaimedByYou,
    AlreadyClaimedBySomeoneElse,
    Expired,
}

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

<ReferBusinessLinkUsedRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ReferBusinessToken>String</ReferBusinessToken>
</ReferBusinessLinkUsedRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ReferBusinessLinkUsedResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Api.Dto">
  <ReferredPlace>
    <Guid>00000000-0000-0000-0000-000000000000</Guid>
    <Id>0</Id>
    <ImageUrl>String</ImageUrl>
    <LogoUrl>String</LogoUrl>
    <Name>String</Name>
  </ReferredPlace>
  <ReferringUser>
    <FirstName>String</FirstName>
    <LastName>String</LastName>
    <ProfilePhotoUrl>String</ProfilePhotoUrl>
  </ReferringUser>
  <State>SignInToSee</State>
</ReferBusinessLinkUsedResponse>