POST api/vsp/login

Request Information

URI Parameters

None.

Body Parameters

LoginRequest
NameDescriptionTypeAdditional information
UserName

UserName

string

None.

Password

string

None.

Request Formats

application/json, text/json

Sample:
{
  "UserName": "sample string 1",
  "Password": "sample string 2"
}

application/xml, text/xml

Sample:
<LoginRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SeeTheProWebAPI.Models">
  <Password>sample string 2</Password>
  <UserName>sample string 1</UserName>
</LoginRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

VspLoginResponse
NameDescriptionTypeAdditional information
IsLoginSuccess

boolean

None.

Message

string

None.

AccessToken

string

None.

CompanyName

string

None.

UserName

string

None.

Email

string

None.

Status

string

None.

Tenant

DataTable

None.

SalesRep

DataTable

None.

UserInfo

UserInfo

None.

Response Formats

application/json, text/json

Sample:
{
  "IsLoginSuccess": true,
  "Message": "sample string 2",
  "AccessToken": "sample string 3",
  "CompanyName": "sample string 4",
  "UserName": "sample string 5",
  "Email": "sample string 6",
  "Status": "sample string 7",
  "Tenant": null,
  "SalesRep": [],
  "UserInfo": {
    "AppAccessKey": "sample string 1",
    "AdsObjKey": "sample string 2",
    "ContactKey": 1,
    "ContactId": "sample string 3",
    "AdsObjId": "sample string 4",
    "ContactFirstName": "sample string 5",
    "ContactLastName": "sample string 6",
    "ContactStatusId": {},
    "ContactAddressLine1": "sample string 8",
    "ContactCity": "sample string 9",
    "ContactState": "sample string 10",
    "ContactZipCode": "sample string 11",
    "ContactCountry": "sample string 12",
    "ContactEmail": "sample string 13",
    "ContactPhone": "sample string 14",
    "ContactUserTypeId": 1,
    "CMPRoleId": 1,
    "SpectrumRoleId": 1,
    "XYZReviewsRoleId": 1,
    "VSPRoleId": 1,
    "ContactCreatedOn": "2025-12-14T02:42:17.0967247+00:00",
    "ContactModifiedOn": "2025-12-14T02:42:17.0967247+00:00",
    "ContactFullName": "sample string 15",
    "IsMobileVerified": true,
    "AccountKey": 1,
    "AccountId": "sample string 16",
    "AccountName": "sample string 17",
    "CableCompanyId": {},
    "AccountAddressLine1": "sample string 19",
    "AccountCity": "sample string 20",
    "AccountState": "sample string 21",
    "AccountZipCode": "sample string 22",
    "AccountCountry": "sample string 23",
    "AccountEmail": "sample string 24",
    "AccountPhone": "sample string 25",
    "AccountTypeId": 1,
    "Website": {},
    "PrimaryContactId": {},
    "FBUrl": {},
    "GooglePlaceId": {},
    "MySiteUrl": {},
    "IsSpectrumAvailable": 1,
    "IsVSPAvailable": 1,
    "IsWirelessAvailable": 1,
    "IsXyzPaysAvailable": 1,
    "IsXyzReviewsAvailable": 1,
    "SpectrumAccountStatus": 1,
    "SpectrumTrendId": 1,
    "XyzReviewsOrderDate": "2025-12-14T02:42:17.0967247+00:00",
    "XyzReviewsOrderId": "sample string 31",
    "AccountCreatedOn": "2025-12-14T02:42:17.0967247+00:00",
    "ACCountModifiedOn": "2025-12-14T02:42:17.0967247+00:00",
    "CMPCreatedOn": "2025-12-14T02:42:17.0967247+00:00",
    "IsXYZReviewsAccount": true,
    "IsCRMAvailable": true,
    "XYZReviewsProductName": "sample string 32",
    "XYZReviewsPaymentMethod": "sample string 33",
    "SubscriptionEndDate": "2025-12-14T02:42:17.0967247+00:00",
    "SubscriptionCancelDate": "2025-12-14T02:42:17.0967247+00:00",
    "Subscriptionprice": 1.0,
    "XYZRetailerId": {},
    "PassKey": "sample string 35",
    "B2CRole": "sample string 36"
  }
}

application/xml

Sample:

Sample not available.

text/xml

Sample:

Sample not available.