POST api/v4/Users/AuthenticateService

Authenticate a service user. Note that there are no parameters in the request. Instead the username and password of the service user should be passed in the Authorization header.

Request Parameters

None.

Response Parameters

userAuthenticateServiceResponse: object of type UserAuthenticateServiceResponse

Name	Description Usage	Type Allowed values	Required?
sessionToken	Session token to be used for maintaining session state across batch operations.	String	yes
baseSystemVersion	Indicates the version of the underlying Store Fulfillment core application.	String	yes

Example - Authenticate Service User

XML Request

Authorization: Basic U2VydmljZTpzZXJ2aWNlOg==

<UserAuthenticateServiceRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4" />

XML Response

<UserAuthenticateServiceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <baseSystemVersion>45</baseSystemVersion>
   <sessionToken>1O1LTE2ANDYDECNT</sessionToken>
</UserAuthenticateServiceResponse>

JSON Request

Authorization: Basic U2VydmljZTpzZXJ2aWNlOg==

{}

JSON Response

{
   "sessionToken": "L3NA0WCZUTFI9S23",
   "baseSystemVersion": "45"
}

Example - Use service token to authenticate user

XML Request

Authorization: Basic am55c3QzX3NuOjo6MU8xTFRFMkFORFlERUNOVA==

<UserAuthenticateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <pushnotificationToken i:nil="true" />
</UserAuthenticateRequest>

XML Response

<UserAuthenticateResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" 
xmlns="http://schemas.datacontract.org/2004/07/VendorNet.Web.Api.Contracts.V4">
   <baseSystemVersion>45</baseSystemVersion>
   <sessionToken>QKIT9NHF2KXURX0E</sessionToken>
   <user>
      <userAttributes>
         <Attribute>
            <key>UserIsManager</key>
            <value>0</value>
         </Attribute>
         <Attribute>
            <key>UserIsRoaming</key>
            <value>0</value>
         </Attribute>
      </userAttributes>
      <userConfiguration>
         <sessionTimeoutMinutes>30</sessionTimeoutMinutes>
         <userConfigurationSettings>
            <UserConfigurationSetting>
               <userSetting>PickTicketsEnabled</userSetting>
               <userSettingValue>true</userSettingValue>
            </UserConfigurationSetting>
            <UserConfigurationSetting>
               <userSetting>PickTicketPickByNameRequired</userSetting>
               <userSettingValue>false</userSettingValue>
            </UserConfigurationSetting>
            <UserConfigurationSetting>
               <userSetting>PickTicketPartialPickReasonRequired</userSetting>
               <userSettingValue>true</userSettingValue>
            </UserConfigurationSetting>
            <UserConfigurationSetting>
               <userSetting>PickTicketPartialPickPromptReason</userSetting>
               <userSettingValue>true</userSettingValue>
            </UserConfigurationSetting>
            <UserConfigurationSetting>
               <userSetting>PickTicketPartialPickCustomReasonsEnabled</userSetting>
               <userSettingValue>false</userSettingValue>
            </UserConfigurationSetting>
         </userConfigurationSettings>
         <userFlags>3</userFlags>
         <userIsAdmin>false</userIsAdmin>
      </userConfiguration>
      <userEmail i:nil="true" />
      <userFirstName/>
      <userLastName i:nil="true" />
      <userName>jnyst3_sn</userName>
      <vendorName>JNYST3</vendorName>
      <vendorNumber>jnyst3</vendorNumber>
   </user>
</UserAuthenticateResponse>

JSON Request

Authorization: Basic am55c3QzX3NuOjo6MU8xTFRFMkFORFlERUNOVA==

{
   "pushnotificationToken":null
}

JSON Response

{
   "user": {
      "vendorNumber": "jnyst3",
      "vendorName": "JNYST3",
      "userName": "jnyst3_sn",
      "userFirstName": "",
      "userLastName": null,
      "userEmail": null,
      "userConfiguration": {
         "sessionTimeoutMinutes": 30,
         "userIsAdmin": false,
         "userFlags": 3,
         "userConfigurationSettings": [{
            "userSetting": "PickTicketsEnabled",
            "userSettingValue": "true"
         },
         {
            "userSetting": "PickTicketPickByNameRequired",
            "userSettingValue": "false"
         },
         {
            "userSetting": "PickTicketPartialPickReasonRequired",
            "userSettingValue": "true"
         },
         {
            "userSetting": "PickTicketPartialPickPromptReason",
            "userSettingValue": "true"
         },
         {
            "userSetting": "PickTicketPartialPickCustomReasonsEnabled",
            "userSettingValue": "false"
         }]
      },
      "userAttributes": [{
         "key": "UserIsManager",
         "value": "0"
      },
      {
         "key": "UserIsRoaming",
         "value": "0"
      }]
   },
   "sessionToken": "N89C9THYV4HHYZUY",
   "baseSystemVersion": "45"
}