Page Comparison

...

Field	Data Type	Documentation
SessionId	AnsiString	SessionId to pass into service methods for the current client session
CompanyId	Integer	Your CompanyId/RetailerId to pass into service methods
LoginDateTime	DateTime	Timestamp of session creation

Methods:

Anchor
Login23
Login23
Login23

Parameters:

Flag	Name	Type	Documentation
In	LoginRequest	vtLoginInfo4	Input struct, see field descriptions above
Out	LoginResult	vtLoginResult17	Output struct, see field descriptions above

...

Flag	Name	Type	Documentation
Result	Result	Boolean	Returns True/False if login was sucsessfullsuccessful

C# Syntax:

public Boolean vtUserServices.Login23(vtLoginInfo4 LoginRequest , out vtLoginResult17 LoginResult);

SOAP

...

Examples:

Code Block

language	xml
title	Request
collapse	true

<?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">

...


   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">

...


      <v1:vtUserServices___Login23 xmlns:v1="http://tempuri.org/">

...


         <v1:LoginRequest>

...


            <v1:ApplicationID>ApplicationID</v1:ApplicationID>

...


            <v1:Username>UserName</v1:Username>

...


            <v1:Password>Password</v1:Password>

...


            <v1:ApplicationVersion />

...


            <v1:IPAddress />

...


            <v1:HTTPReferrer />

...


         </v1:LoginRequest>

...


      </v1:vtUserServices___Login23>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Code Block

language	xml
title	Response
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:v1="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">
      <v1:vtUserServices___Login23Response>
         <v1:Result>true</v1:Result>
         <v1:LoginResult>
            <v1:AppBillingRate>0</v1:AppBillingRate>
            <v1:BillingRate>0</v1:BillingRate>
            <v1:CanAdmin>false</v1:CanAdmin>
            <v1:CanCall>false</v1:CanCall>
            <v1:CanEdit>false</v1:CanEdit>
            <v1:CanLocal>false</v1:CanLocal>
            <v1:CanSelect>true</v1:CanSelect>
            <v1:CanSynch>false</v1:CanSynch>
            <v1:CanTask>false</v1:CanTask>
            <v1:CanWebAdmin>false</v1:CanWebAdmin>
            <v1:CompanyId>16952</v1:CompanyId>
            <v1:ForumAuthorId>0</v1:ForumAuthorId>
            <v1:HomepagePath />
            <v1:LastNPDSubmission>1899-12-30T00:00:00</v1:LastNPDSubmission>
            <v1:LoginDateTime>2015-11-13T11:42:23.272</v1:LoginDateTime>
            <v1:Member>false</v1:Member>
            <v1:MERALevel>0</v1:MERALevel>
            <v1:SerialPrefix />
            <v1:SessionId>SessionId</v1:SessionId>
            <v1:StructureDates>
               <v1:Attributes>2014-08-04T11:04:05.303</v1:Attributes>
               <v1:CommonInstalls>2013-05-30T16:07:14.497</v1:CommonInstalls>
               <v1:Documents>2015-11-12T15:15:11.56</v1:Documents>
               <v1:HorizontalStructure>2013-09-19T16:34:22.857</v1:HorizontalStructure>
               <v1:Products>2015-10-27T16:53:21.47</v1:Products>
            </v1:StructureDates>
            <v1:TopTierApp>false</v1:TopTierApp>
            <v1:VehicleSubscriptionInfo>
               <v1:AllowedVehicles>-1</v1:AllowedVehicles>
               <v1:AvailableVehicles>-1</v1:AvailableVehicles>
               <v1:SubscribedVehicleIds />
            </v1:VehicleSubscriptionInfo>
         </v1:LoginResult>
      </v1:vtUserServices___Login23Response>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

JSON Examples:

Code Block

title	Request
collapse	true

{
   "version":"1.1",
   "method":"vtUserServices.Login23",
   "params":{
      "LoginRequest":{
         "ApplicationID":"ApplicationID",
         "ApplicationVersion":"",
         "HTTPReferrer":"",
         "IPAddress":"",
         "Password":"Password",
         "Username":"UserName"
      }
   }
}

Code Block

title	Response
collapse	true

{
   "version":"1.1",
   "result":{
      "Result":true,
      "LoginResult":{
         "AppBillingRate":"0",
         "BillingRate":"99.95",
         "CanAdmin":false,
         "CanCall":false,
         "CanEdit":false,
         "CanLocal":false,
         "CanSelect":true,
         "CanSynch":false,
         "CanTask":false,
         "CanWebAdmin":false,
         "CompanyId":"16952",
         "ForumAuthorId":"0",
         "HomepagePath":"",
         "LastNPDSubmission":"1899-12-30T00:00:00",
         "LoginDateTime":"2017-09-22T16:35:34.922",
         "Member":false,
         "MERALevel":"0",
         "SchedulingInfo":{
            "SchedulingEnabled":false,
            "SchedulingSetup":true
         },
         "SerialPrefix":"RFG",
         "Services":[
            {
               "AppServiceId":"{9B225ACB-229E-43C6-8CD6-7A79D4A7D7AA}",
               "AppServiceName":"CSR Documents",
               "Deleted":false,
               "Price":"99.95"
            }
         ],
         "SessionId":"5E0CA6A3-E891-4F20-8BC8-100001D0EA7B",
         "StructureDates":{
            "Attributes":"2014-08-04T11:04:05.303",
            "CommonInstalls":"2013-05-30T16:07:14.497",
            "Documents":"2016-11-22T14:16:31.587",
            "HorizontalStructure":"2013-09-19T16:34:22.857",
            "Products":"2017-09-12T16:35:43.593"
         },
         "TopTierApp":false,
         "VehicleSubscriptionInfo":{
            "AllowedVehicles":"-1",
            "AvailableVehicles":"-1",
            "SubscribedVehicleIds":[
            ]
         }
      }
   }
}

Anchor
LogOff
LogOff
Logoff

Parameters:

Flag	Name	Type	Documentation
In	SessionID	AnsiString	SessionID to log off

Return Value:

Flag	Name	Type	Documentation
Result	Result	Boolean	Returns True/False if logoff was successful

C# Syntax:

public Boolean vtUserServices.Logoff(AnsiString SessionID);

SOAP Examples:

Code Block

language	xml
title	Request
collapse	true

 <?xml version="1.0" encoding="UTF-8"?>

...


<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">
      <v1:vtUserServices___Logoff xmlns:v1="http://tempuri.org/">
         <v1:SessionID>SessionID</v1:SessionID>
      </v1:vtUserServices___Logoff>
   </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

Code Block

language	xml
title	Response
collapse	true

<?xml version="1.0" encoding="UTF-8"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:HNS="http://tempuri.org/" xmlns:v1="http://tempuri.org/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
   <SOAP-ENV:Body xmlns:ro="http://tempuri.org/">
      <v1:vtUserServices___LogoffResponse>
         <v1:Result>true</v1:Result>
      </v1:vtUserServices___LogoffResponse>
   </SOAP-ENV:Body>

...


</SOAP-ENV:Envelope>

JSON Examples:

Code Block

title	Request
collapse	true

{
    "version":"1.1",
    "method":"vtUserServices.Logoff",
    "params":{
       "SessionID":"SessionID"
    }
}

Code Block

title	Response
collapse	true

{
   "version":"1.1",
   "result":{
      "Result":true
   }
}

Version	Old Version 3	New Version Current
Changes made by	Former user	Matt Eaton
Saved on	Nov 13, 2015	Sept 22, 2017

Versions Compared

Key

Methods:

Anchor
Login23
Login23
Login23

Parameters:

C# Syntax:

SOAP

Examples:

JSON Examples:

Anchor
LogOff
LogOff
Logoff

Parameters:

Return Value:

C# Syntax:

SOAP Examples:

JSON Examples:

Page Comparison

Versions Compared

Key

Methods:

AnchorLogin23Login23Login23

Parameters:

C# Syntax:

SOAP

Examples:

JSON Examples:

AnchorLogOffLogOffLogoff

Parameters:

Return Value:

C# Syntax:

SOAP Examples:

JSON Examples:

Anchor
Login23
Login23
Login23

Anchor
LogOff
LogOff
Logoff