POST | /share/refer-business-link-used | A business referral link was used | Validates the JWT token with the identity of the referring user and the place, and returns relevant information. |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReferBusinessToken | body | string | Yes |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ReferringUser | form | ReferBusinessUser | No | |
ReferredPlace | form | ReferredPlace | No | |
ExpiresAt | form | DateTimeOffset? | No | |
State | form | ReferBusinessState | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
FirstName | form | string | Yes | |
LastName | form | string | Yes | |
ProfilePhotoUrl | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | long | No | |
Guid | form | Guid | No | |
Name | form | string | Yes | |
LogoUrl | form | string | No | |
ImageUrl | form | string | No |
SignInToSee | |
Available | |
CanNotReferYourself | |
AlreadyClaimedByYou | |
AlreadyClaimedBySomeoneElse | |
Expired |
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
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: 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"},"expiresAt":"0001-01-01T00:00:00.0000000+00:00","state":"SignInToSee"}