POST api/Site/SiteCodeWordUpdateFull

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
SeqNum	integer	None.
ChangeFlagSeqNum	boolean	None.
Authority	string	None.
ChangeFlagAuthority	boolean	None.
CodeWord	string	None.
ChangeFlagCodeWord	boolean	None.
CodeWordQuestion	string	None.
ChangeFlagCodeWordQuestion	boolean	None.
EffectiveDate	date	None.
ChangeFlagEffectiveDate	boolean	None.
ExpireDate	date	None.
ChangeFlagExpireDate	boolean	None.
SiteNum	integer	None.
DevNum	integer	None.
TransmitterCode	string	None.
SessionNum	integer	None.
SessionPassword	Collection of byte	None.
ApplicationCode	string	None.
StagesURL	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SeqNum": 1,
  "ChangeFlagSeqNum": true,
  "Authority": "sample string 1",
  "ChangeFlagAuthority": true,
  "CodeWord": "sample string 2",
  "ChangeFlagCodeWord": true,
  "CodeWordQuestion": "sample string 3",
  "ChangeFlagCodeWordQuestion": true,
  "EffectiveDate": "2025-05-03T22:05:04.2132419-07:00",
  "ChangeFlagEffectiveDate": true,
  "ExpireDate": "2025-05-03T22:05:04.2132419-07:00",
  "ChangeFlagExpireDate": true,
  "SiteNum": 1,
  "DevNum": 1,
  "TransmitterCode": "sample string 4",
  "SessionNum": 5,
  "SessionPassword": "QEA=",
  "ApplicationCode": "sample string 6",
  "StagesURL": "sample string 7"
}

application/xml, text/xml

Sample:

<CodeWordFullRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RapidAPI.Models">
  <StagesURL>sample string 7</StagesURL>
  <ApplicationCode>sample string 6</ApplicationCode>
  <SessionNum>5</SessionNum>
  <SessionPassword>QEA=</SessionPassword>
  <DevNum>1</DevNum>
  <SiteNum>1</SiteNum>
  <TransmitterCode>sample string 4</TransmitterCode>
  <Authority>sample string 1</Authority>
  <ChangeFlagAuthority>true</ChangeFlagAuthority>
  <ChangeFlagCodeWord>true</ChangeFlagCodeWord>
  <ChangeFlagCodeWordQuestion>true</ChangeFlagCodeWordQuestion>
  <ChangeFlagEffectiveDate>true</ChangeFlagEffectiveDate>
  <ChangeFlagExpireDate>true</ChangeFlagExpireDate>
  <ChangeFlagSeqNum>true</ChangeFlagSeqNum>
  <CodeWord>sample string 2</CodeWord>
  <CodeWordQuestion>sample string 3</CodeWordQuestion>
  <EffectiveDate>2025-05-03T22:05:04.2132419-07:00</EffectiveDate>
  <ExpireDate>2025-05-03T22:05:04.2132419-07:00</ExpireDate>
  <SeqNum>1</SeqNum>
</CodeWordFullRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SiteCodeWordUpdateQueryResult

Name	Type	Additional information
ExcludeColumnList	Collection of string	None.
ResultSet	Collection of SiteCodeWordUpdateResult	None.
Success	boolean	None.
UserErrorMessage	string	None.
ErrorTypeNum	integer	None.
SqlConnectionLost	boolean	None.
ClientVersion	string	None.

Response Formats

application/json, text/json

Sample:

{
  "ExcludeColumnList": [
    "sample string 1",
    "sample string 2"
  ],
  "ResultSet": [
    {
      "AdditionalDataFlag": true,
      "Authority": "sample string 1",
      "AuthorityDescription": "sample string 2",
      "CodeWord": "sample string 3",
      "CodeWordQuestion": "sample string 4",
      "CustomFlag": true,
      "EffectiveDate": "2025-05-03T22:05:04.2288928-07:00",
      "ExpireDate": "2025-05-03T22:05:04.2288928-07:00",
      "SeqNum": 1,
      "SiteName": "sample string 5",
      "SiteNum": 1,
      "PINCodeWordOK": "sample string 6",
      "DefaultAuthority": "sample string 7",
      "DefaultAuthorityDescription": "sample string 8"
    },
    {
      "AdditionalDataFlag": true,
      "Authority": "sample string 1",
      "AuthorityDescription": "sample string 2",
      "CodeWord": "sample string 3",
      "CodeWordQuestion": "sample string 4",
      "CustomFlag": true,
      "EffectiveDate": "2025-05-03T22:05:04.2288928-07:00",
      "ExpireDate": "2025-05-03T22:05:04.2288928-07:00",
      "SeqNum": 1,
      "SiteName": "sample string 5",
      "SiteNum": 1,
      "PINCodeWordOK": "sample string 6",
      "DefaultAuthority": "sample string 7",
      "DefaultAuthorityDescription": "sample string 8"
    }
  ],
  "Success": true,
  "UserErrorMessage": "sample string 2",
  "ErrorTypeNum": 3,
  "SqlConnectionLost": true,
  "ClientVersion": "sample string 5"
}

application/xml, text/xml

Sample:

<SiteCodeWordUpdateQueryResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Stages">
  <ClientVersion>sample string 5</ClientVersion>
  <ErrorTypeNum>3</ErrorTypeNum>
  <SqlConnectionLost>true</SqlConnectionLost>
  <Success>true</Success>
  <UserErrorMessage>sample string 2</UserErrorMessage>
  <ExcludeColumnList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeColumnList>
  <ResultSet>
    <SiteCodeWordUpdateResult>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <Authority>sample string 1</Authority>
      <AuthorityDescription>sample string 2</AuthorityDescription>
      <CodeWord>sample string 3</CodeWord>
      <CodeWordQuestion>sample string 4</CodeWordQuestion>
      <CustomFlag>true</CustomFlag>
      <DefaultAuthority>sample string 7</DefaultAuthority>
      <DefaultAuthorityDescription>sample string 8</DefaultAuthorityDescription>
      <EffectiveDate>2025-05-03T22:05:04.2288928-07:00</EffectiveDate>
      <ExpireDate>2025-05-03T22:05:04.2288928-07:00</ExpireDate>
      <PINCodeWordOK>sample string 6</PINCodeWordOK>
      <SeqNum>1</SeqNum>
      <SiteName>sample string 5</SiteName>
      <SiteNum>1</SiteNum>
    </SiteCodeWordUpdateResult>
    <SiteCodeWordUpdateResult>
      <AdditionalDataFlag>true</AdditionalDataFlag>
      <Authority>sample string 1</Authority>
      <AuthorityDescription>sample string 2</AuthorityDescription>
      <CodeWord>sample string 3</CodeWord>
      <CodeWordQuestion>sample string 4</CodeWordQuestion>
      <CustomFlag>true</CustomFlag>
      <DefaultAuthority>sample string 7</DefaultAuthority>
      <DefaultAuthorityDescription>sample string 8</DefaultAuthorityDescription>
      <EffectiveDate>2025-05-03T22:05:04.2288928-07:00</EffectiveDate>
      <ExpireDate>2025-05-03T22:05:04.2288928-07:00</ExpireDate>
      <PINCodeWordOK>sample string 6</PINCodeWordOK>
      <SeqNum>1</SeqNum>
      <SiteName>sample string 5</SiteName>
      <SiteNum>1</SiteNum>
    </SiteCodeWordUpdateResult>
  </ResultSet>
</SiteCodeWordUpdateQueryResult>