1. Help
  2. PUT SETLOCK_PENDING_PROGRAMBANK_INFO

PUT SETLOCK_PENDING_PROGRAMBANK_INFO

Set Lock Pending Program Bank Info.

Request Information

URI Parameters

None.

Body Parameters

SetLockPdngProgramBankInfoRequest

SetLockPdngProgramBankInfoRequest
NameDescriptionTypeAdditional information
LockEntity

Entity value for the lock (database value)

 integer

Required
PendBankModeStatus

Parameter data - pending bank mode status

 string

Required
PendBankModeStart

Pending Bank Mode Start Date. Valid format ("dd/MM/yyyyHH:mm").

 string

Required
PendBankModeEnd

Pending Bank Mode End Date. Valid format ("dd/MM/yyyyHH:mm").

 string

Required
PendTampResetStatus

Parameter data - pending tamper reset status

 string

Required
PendAuditStatus

Parameter data - pending audit status

 string

Required

Request Formats

application/json, text/json

Sample: 
{
  "LockEntity": 1,
  "PendBankModeStatus": "sample string 2",
  "PendBankModeStart": "sample string 3",
  "PendBankModeEnd": "sample string 4",
  "PendTampResetStatus": "sample string 5",
  "PendAuditStatus": "sample string 6"
}

application/xml, text/xml

Sample: 
<SetLockPdngProgramBankInfoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Lock">
  <LockEntity>1</LockEntity>
  <PendAuditStatus>sample string 6</PendAuditStatus>
  <PendBankModeEnd>sample string 4</PendBankModeEnd>
  <PendBankModeStart>sample string 3</PendBankModeStart>
  <PendBankModeStatus>sample string 2</PendBankModeStatus>
  <PendTampResetStatus>sample string 5</PendTampResetStatus>
</SetLockPdngProgramBankInfoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SetLockPdngProgramBankInfoResponse

SetLockPdngProgramBankInfoResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.
Body

SetLockPdngProgramBankInfoResponseBody

None.

Response Header Description

ResponseHeader
NameDescriptionTypeAdditional information
Message

Message

 string

None.
StatusCode

Status code

 ResponseStatus

None.
Status

Status

 string

None.
ErrorId

Error id

 string

None.

Response Body Description

SetLockPdngProgramBankInfoResponseBody
NameDescriptionTypeAdditional information
SetLockPdngProgramBankInfoUpdated

Flag to show if parameter data successfully saved

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Header": {
    "Message": "sample string 1",
    "StatusCode": 0,
    "Status": "sample string 2",
    "ErrorId": "sample string 3"
  },
  "Body": {
    "SetLockPdngProgramBankInfoUpdated": true
  }
}

application/xml, text/xml

Sample: 
<SetLockPdngProgramBankInfoResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Lock">
  <Body xmlns:d2p1="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses.Lock" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <d2p1:SetLockPdngProgramBankInfoUpdated>true</d2p1:SetLockPdngProgramBankInfoUpdated>
  </Body>
  <Header xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Responses">
    <ErrorId>sample string 3</ErrorId>
    <Message>sample string 1</Message>
    <Status>sample string 2</Status>
    <StatusCode>Ok</StatusCode>
  </Header>
</SetLockPdngProgramBankInfoResponse>
© 2025 Sargent and Greenleaf