Login

Login

The Login API allows login to Praxell applications

Input Parameters:

Name	Required	Definition	Comments
AuthenticationCode	C	Format: Alphanumeric, 10 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceAuthenticationCode	C	Format: Alphanumeric, 10 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceBrowserType	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceBrowserVersion	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceColorDepth	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceCookiesEnablement	C	Format: Y/N Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceGeolocation	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceOSType	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceOSVersion	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceScreenSize	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future
DeviceTimeZone	C	Format: Alphanumeric, 100 Description: Required if PortalUserName & Password are provided(PDP)	Future

Output Parameters:

Name	Definition	Failure Case	Success Case	Comments
AuthenticationCode	Format: Alphanumeric, 10 Description: Required if PortalUserName & Password are provided(PDP)	Not returned	Returned	Future
AuthenticationContactDisplayName	Format: Alphanumeric, 60 Description: Relevant if PortalUserName & Password are provided(PDP)	Not returned	Returned	Future
AuthenticationContactUser	Format: Alphanumeric, 60 Description: Relevant if PortalUserName & Password are provided(PDP)	Not returned	Returned	Future
AuthenticationRequestStatus	Format options: Authenticated NotAuthenticatedWarning NotAuthenticated AuthenticationCreated Description: Relevant if PortalUserName & Password are provided(PDP)	Not returned	Returned	Future
BrandStyle	Format: Alphanumeric, 5	Not returned	Returned
Email	Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern: x@x.x	Not returned	Returned	Future
FirstName	Format: Alphanumeric, 10	Not returned	Returned	Future
Timeout	Format: Numeric, 3	Not returned	Returned
UserRoleId	Format: Alphanumeric, 10	Not returned	Returned
LastLoginTime	Format: YYYY-MM-DD HH:MM:SS	Not returned	Returned
LastName	Format: Alphanumeric, 15	Not returned	Returned	Future
OrgAddressLine1	Format: Alphanumeric, 30	Not returned	Returned	Future
OrgAddressLine2	Format: Alphanumeric, 30	Not returned	Returned	Future
OrgCity	Format: Alphanumeric, 20	Not returned	Returned	Future
OrgCountry	Format: Alphanumeric, 3	Not returned	Returned	Future
OrgEmail	Format: a-z (upper or lower), numbers, dash and underscore, 5-40 Description: Possible pattern: x@x.x	Not returned	Returned	Future
OrgFax	Format: Alphanumeric, 10	Not returned	Returned	Future
OrgId	Format: Alphanumeric, 20 Value can be multiple org_id’s split by commas	Not returned	Returned	Future
OrgName	Format: Alphanumeric, 1-30	Not returned	Returned	Future
OrgPhone	Format: Alphanumeric, 10	Not returned	Returned	Future
OrgRoleId	Format: Alphanumeric, 10	Not returned	Returned
OrgState	Format: Alphanumeric, 2	Not returned	Returned	Future
OrgZip	Format: Alphanumeric, 5	Not returned	Returned	Future

XML Samples

Input XML

<?xml version="1.0" ?>
 <PraxellXMLRequest>
   <AuthenticationDetails>
      <UserName></UserName>
      <UserPassword></UserPassword>
      <AuthCardNumber>9999999999998000</AuthCardNumber>
      <AuthPIN>1234</AuthPIN>
      <TerminalId></TerminalId>
      <ExternalStoreId></ExternalStoreId>
      <NetworkId></NetworkId>
      <SessionId></SessionId>
     <ClientSourceIP></ClientSourceIP> 
 </AuthenticationDetails>;
   <ServiceDetails>
     <ServiceName>Login</ServiceName>
     <UniqueRequestId>1212121212121213</UniqueRequestId>
   </ServiceDetails>
   <Origin>
       <OriginType>ExtAPI</OriginType>
   </Origin>
   <ServiceParams>
  </ServiceParams>
</PraxellXMLRequest>

<?xml version="1.0"?>
   <PraxellXMLResponse>
     <ResponseDetails>
         <ServiceName>Login</ServiceName>
         <SessionId>38012411200857032</SessionId>
        <StatusCode>0</StatusCode>
        <StatusName>StatusOK</StatusName>
        <StatusDescription>NA</StatusDescription>
        <ServiceDate>2008-03-12 11:57:25</ServiceDate>
        <ServiceId>38012411200857032</ServiceId>
    </ResponseDetails>
    <ResponseParams>
       <BrandStyle></BrandStyle>
       <Timeout>30</Timeout>
       <UserRoleId>CH</UserRoleId>
       <LastLoginTime></LastLoginTime>
       <OrgRoleId>Store</OrgRoleId>
  </ResponseParams>
</PraxellXMLResponse>

<?xml version="1.0"?>
<PraxellXMLResponse>
  <ResponseDetails>
    <ServiceName>Login</ServiceName>
    <SessionId>07071612200737105</SessionId>
    <StatusCode>70029</StatusCode>
    <StatusName>Data not found (cardholder not found)</StatusName>
    <StatusDescription>Data not found (cardholder not found)</StatusDescription>
    <ServiceDate>2021-10-01 12:37:50</ServiceDate>
    <ServiceId>07071612200737105</ServiceId>
  </ResponseDetails>
  <ResponseParams>
  </ResponseParams>
</PraxellXMLResponse>