GetProfile

Queries the state of the CyberStore Session and returns profile information about the User Account logged into that session.

GetProfile Post Parameters

When you post queries to the GetProfile operation, you must submit the following parameters to retrieve the information:

Parameter	Description
ClientCode	A unique value assigned to your application after it is registered within the CyberStore Console > CyberStore Connect maintenance screen. You must include this value in your request.
SessionToken	A unique value assigned by the CyberStore application to a user’s unique session. It is created after a successful login to the website via the CyberStore login screen. You must include this value in your request. Information about how to receive and capture the SessionToken is described in more detail later in this document.
ClientSession_ID	A unique identifier created by the application that runs on your registered client application. You need to capture it and send it with your request. CyberStore Connect utilizes this value, combined with the SessionToken and ClientCode, to validate the authenticity of the request.

When you submit a request to the GetProfile operation, the response message is returned as an XML string. A query posted with the required, authenticated parameters returns results similar to the XML string below:

Example GetProfile Query Results	Copy Code
<?xml version="1.0" encoding="utf-8"?> <CyberStoreConnect> <Profile> <FirstName><![CDATA[Susan]]></FirstName> <LastName><![CDATA[Brown]]></LastName> <FullName><![CDATA[Susan Brown]]></FullName> <Username><![CDATA[sbrown@bikesblades.com]]></Username> <EmailAddress><![CDATA[sbrown@bikesblades.com]]></EmailAddress> <CustomerClass><![CDATA[Wholesaler]]></CustomerClass> <Customer><![CDATA[000002]]></Customer> <CustomerName><![CDATA[Bikes & Blades – North]]></CustomerName> <ViewList><![CDATA[Wholesaler View]]></ViewList> </Profile> <EventResponse> <Module>API</Module> <Severity>0</Severity> <Number>000</Number> <Message>Success!</Message> </EventResponse> </CyberStoreConnect>

Example GetProfile Query Results

Copy Code

<?xml version="1.0" encoding="utf-8"?>
<CyberStoreConnect>
  <Profile>
    <FirstName><![CDATA[Susan]]></FirstName>
    <LastName><![CDATA[Brown]]></LastName>
    <FullName><![CDATA[Susan Brown]]></FullName>
    <Username><![CDATA[sbrown@bikesblades.com]]></Username>
    <EmailAddress><![CDATA[sbrown@bikesblades.com]]></EmailAddress>
    <CustomerClass><![CDATA[Wholesaler]]></CustomerClass>
    <Customer><![CDATA[000002]]></Customer>
    <CustomerName><![CDATA[Bikes & Blades – North]]></CustomerName>
    <ViewList><![CDATA[Wholesaler View]]></ViewList>
  </Profile>
  <EventResponse>
    <Module>API</Module>
    <Severity>0</Severity>
    <Number>000</Number>
    <Message>Success!</Message>
  </EventResponse>
</CyberStoreConnect>

The XML string above contains the following elements:

Element	Description
Profile	The information about the logged-in user’s session profile.
Profile/FirstName	The first name of the logged-in user from their registered CyberStore Account.
Profile/LastName	The last name of the logged-in user from their registered CyberStore Account.
Profile/FullName	The full name (FirstName + LastName) of the logged-in user from their registered CyberStore Account.
Profile/Username	The username of the logged-in user from their registered CyberStore Account.
Profile/EmailAddress	The email address of the logged-in user from their registered CyberStore Account.
Profile/CustomerClass	The CyberStore Customer Class assigned to the logged-in user’s SYSPRO Customer.
Profile/Customer	The current SYSRPO Customer Number of the logged-in user.
Profile/CustomerName	The current SYSPRO Customer Name of the logged-in user.
Profile/ViewList	The current CyberStore View List for the logged-in user.
EventResponse	The details about the success or failure of the request. This includes a module, severity, response number and message. A response number of ‘000’ with a message of “Success!” indicates that the request has been completed successfully.
EventResponse/Module	The CyberStore module that is responsible for the response. Typically, “API” is returned.
EventResponse/Severity	The severity of the response, from 0 to 9.
EventResponse/Number	The value that uniquely identifies the specific response.
EventResponse/Message	The message returned by CyberStore that describes what occurred.

CyberStore Connect Response Number Codes

CyberStore Connect Response Number Codes Overview