This function will change the PIN for a user record. INPUTS==> USER ID, PIN, OPERATOR ID, OPERATOR PASSWORD. RETURN==> (result)
None.
ModifyUserPinRequest
ModifyUserPinRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| UserId |
User ID of technician who will be changing PIN values |
string |
Required |
| NewPIN |
New PIN value |
string |
Required Matching regular expression pattern: ([0-9]+) Max length: 4 Min length: 4 |
| ConfirmNewPIN |
New PIN value |
string |
Required Matching regular expression pattern: ([0-9]+) Max length: 4 Min length: 4 |
| OperatorId |
Operator ID for the operator authorizing the PIN change |
string |
Required |
| OperatorPassword |
Password for the operator authorizing the PIN change |
string |
Required |
{
"UserId": "User01",
"NewPIN": "1234",
"ConfirmNewPIN": "1234",
"OperatorId": "lmsoper",
"OperatorPassword": "lmsoperPassword"
}
<ModifyUserPinRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.User"> <ConfirmNewPIN>1234</ConfirmNewPIN> <NewPIN>1234</NewPIN> <OperatorId>lmsoper</OperatorId> <OperatorPassword>lmsoperPassword</OperatorPassword> <UserId>User01</UserId> </ModifyUserPinRequest>
UserId=User01&NewPIN=1234&ConfirmNewPIN=1234&OperatorId=lmsoper&OperatorPassword=lmsoperPassword
ModifyUserPinResponse
ModifyUserPinResponse| Name | Description | Type | Additional information |
|---|---|---|---|
| Header | ResponseHeader |
None. |
|
| Body | ModifyUserPinResponseBody |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| Message |
Message |
string |
None. |
| StatusCode |
Status code |
ResponseStatus |
None. |
| Status |
Status |
string |
None. |
| ErrorId |
Error id |
string |
None. |
| Name | Description | Type | Additional information |
|---|---|---|---|
| PinModified |
Flag to show if PIN was successfully changed |
boolean |
None. |
{
"Header": {
"Message": "",
"StatusCode": 0,
"Status": "Ok",
"ErrorId": null
},
"Body": {
"PinModified": true
}
}
<ModifyUserPinResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User">
<Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.User" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<d2p1:PinModified>true</d2p1:PinModified>
</Body>
<Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
<ErrorId i:nil="true" />
<Message></Message>
<Status>Ok</Status>
<StatusCode>Ok</StatusCode>
</Header>
</ModifyUserPinResponse>