Request Information

URI Parameters

None.

Body Parameters

SetClockCalSeqNoRequest

SetClockCalSeqNoRequest
NameDescriptionTypeAdditional information
LockEntity

Entity value for the lock (database value)

integer

Required

ClockCalSeq

Sequence for set clock / calendar command

integer

Required

Request Formats

application/json, text/json

Sample:
{
  "LockEntity": 1,
  "ClockCalSeq": 2
}

application/xml, text/xml

Sample:
<SetClockCalSeqNoRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SaG.API.Models.Requests.Lock">
  <ClockCalSeq>2</ClockCalSeq>
  <LockEntity>1</LockEntity>
</SetClockCalSeqNoRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SetClockCalSeqNoResponse

SetClockCalSeqNoResponse
NameDescriptionTypeAdditional information
Header

ResponseHeader

None.

Body

SetClockCalSeqNoResponseBody

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

SetClockCalSeqNoResponseBody
NameDescriptionTypeAdditional information
SetClockCalSeqNoUpdated

Flag to show if set clock / calendar sequence successfully updated

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": {
    "SetClockCalSeqNoUpdated": true
  }
}

application/xml, text/xml

Sample:
<SetClockCalSeqNoResponse 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:SetClockCalSeqNoUpdated>true</d2p1:SetClockCalSeqNoUpdated>
  </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>
</SetClockCalSeqNoResponse>

© 2025 Sargent and Greenleaf