Agent & User Operations

Change User Password

changeUserPassword

This method is used to change the SHIFT API user password.

Password Creation Rules

• Must contain at least eight alphanumeric characters.
• Must not match any of the last five passwords used.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
newPassword	String	30	Yes	New password
confirmNewPassword	String	30	Yes	Confirm new password

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:changeUserPassword>
         <newPassword>a1234567</newPassword>
         <confirmNewPassword>a1234567</confirmNewPassword>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:changeUserPassword>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns3:changeUserPasswordResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
         <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
         </return>
      </ns3:changeUserPasswordResponse>
   </S:Body>
</S:Envelope>

---

Get Agent Announcements

getAgentAnnouncements

This method is used to retrieve agent announcements sent by SHIFT Operations.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String
AgentAnnouncemetsList	List of Objects	Contains announcement details See below AgentAnnouncemetsList

AgentAnnouncemetsList

AgentAnnouncemetsList Object fields

Field	Type	Description
id	Integer
title	String
body	String
status	String	New, Read

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:getAgentAnnouncements>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:getAgentAnnouncements>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns3:getAgentAnnouncementsResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
         <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
            <ns2:AgentAnnouncemetsList>
               <ns2:id>1443569</ns2:id>
               <ns2:title>test now</ns2:title>
               <ns2:body>test now</ns2:body>
               <ns2:status>New</ns2:status>
            </ns2:AgentAnnouncemetsList>
         </return>
      </ns3:getAgentAnnouncementsResponse>
   </S:Body>
</S:Envelope>

---

Read Announcement

readAnnouncement

This method is used to mark an announcement as read.

Status Change

When called, the announcement status is updated to Read.

Request Inputs

Field	Type	Size	Mandatory	Description
agentCode	String	5	Yes	Agent code assigned by SHIFT
userId	String	20	Yes	User ID assigned by SHIFT
userPassword	String	30	Yes	User password assigned by SHIFT
announcementId	Integer	10	Yes	Announcement Id

Response Outputs

Field	Type	Description
resultCode	String	See the Result Codes and Messages table
resultMessage	String

SOAP Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://webservice/">
   <soapenv:Header/>
   <soapenv:Body>
      <web:readAnnouncement>
         <announcementId>1443569</announcementId>
         <agentCode>*****</agentCode>
         <userId>*****</userId>
         <userPassword>*****</userPassword>
      </web:readAnnouncement>
   </soapenv:Body>
</soapenv:Envelope>

SOAP Response

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <ns3:readAnnouncementResponse xmlns:ns2="http://xml.netbeans.org/schema/ApiSchema" xmlns:ns3="http://webservice/">
         <return>
            <ns2:resultCode>9000</ns2:resultCode>
            <ns2:resultMessage>Operation successfully</ns2:resultMessage>
         </return>
      </ns3:readAnnouncementResponse>
   </S:Body>
</S:Envelope>