POST Client/RequestPreCheckForScriptConfigChange

Before Request Check

Request Information

URI Parameters

None.

Body Parameters

The service request object

ParaRequest
NameDescriptionTypeAdditional information
NeedHelpLanguageId

integer

None.

RequestSituationCodeId

integer

None.

AdditionalInfo

string

None.

FromLanguage

integer

None.

RelatedVersionCode

string

None.

ApplicationCompanyCode

string

None.

DeviceTypeCodeId

integer

None.

ApplicationTypeCodeId

integer

None.

BJCVRIEntityNumber

string

None.

BJCVRIDepartmentPinNumber

string

None.

RequestLocation

string

None.

Request Formats

application/json, text/json

Sample:
{
  "NeedHelpLanguageId": 1,
  "RequestSituationCodeId": 2,
  "AdditionalInfo": "sample string 3",
  "FromLanguage": 1,
  "RelatedVersionCode": "sample string 4",
  "ApplicationCompanyCode": "sample string 5",
  "DeviceTypeCodeId": 1,
  "ApplicationTypeCodeId": 1,
  "BJCVRIEntityNumber": "sample string 6",
  "BJCVRIDepartmentPinNumber": "sample string 7",
  "RequestLocation": "sample string 8"
}

application/xml, text/xml

Sample:
<ParaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <AdditionalInfo>sample string 3</AdditionalInfo>
  <ApplicationCompanyCode>sample string 5</ApplicationCompanyCode>
  <ApplicationTypeCodeId>1</ApplicationTypeCodeId>
  <BJCVRIDepartmentPinNumber>sample string 7</BJCVRIDepartmentPinNumber>
  <BJCVRIEntityNumber>sample string 6</BJCVRIEntityNumber>
  <DeviceTypeCodeId>1</DeviceTypeCodeId>
  <FromLanguage>1</FromLanguage>
  <NeedHelpLanguageId>1</NeedHelpLanguageId>
  <RelatedVersionCode>sample string 4</RelatedVersionCode>
  <RequestLocation>sample string 8</RequestLocation>
  <RequestSituationCodeId>2</RequestSituationCodeId>
</ParaRequest>

Response Information

Resource Description

Returns the transaction server API URL. If null, the transaction server API URL will remain the same

ResultForScriptConfigChange
NameDescriptionTypeAdditional information
RequiredInputUrl

string

None.

HasScript

boolean

None.

TargetLanguageId

integer

None.

SourceLanguageId

integer

None.

BillCompanyProductId

integer

None.

InitialScriptStepCodeId

integer

None.

InitialScriptStepCode

string

None.

conifgs

Collection of ResultScriptConfigDisplay

None.

Response Formats

application/json, text/json

Sample:
{
  "RequiredInputUrl": "sample string 1",
  "HasScript": true,
  "TargetLanguageId": 1,
  "SourceLanguageId": 1,
  "BillCompanyProductId": 1,
  "InitialScriptStepCodeId": 1,
  "InitialScriptStepCode": "sample string 2",
  "conifgs": [
    {
      "ReportName": "sample string 1",
      "Initial": true,
      "ScriptStepId": 1,
      "ScriptStepCode": "sample string 2",
      "InputValue": "sample string 3"
    },
    {
      "ReportName": "sample string 1",
      "Initial": true,
      "ScriptStepId": 1,
      "ScriptStepCode": "sample string 2",
      "InputValue": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:
<ResultForScriptConfigChange xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/API.Models">
  <BillCompanyProductId>1</BillCompanyProductId>
  <HasScript>true</HasScript>
  <InitialScriptStepCode>sample string 2</InitialScriptStepCode>
  <InitialScriptStepCodeId>1</InitialScriptStepCodeId>
  <RequiredInputUrl>sample string 1</RequiredInputUrl>
  <SourceLanguageId>1</SourceLanguageId>
  <TargetLanguageId>1</TargetLanguageId>
  <conifgs>
    <ResultScriptConfigDisplay>
      <Initial>true</Initial>
      <InputValue>sample string 3</InputValue>
      <ReportName>sample string 1</ReportName>
      <ScriptStepCode>sample string 2</ScriptStepCode>
      <ScriptStepId>1</ScriptStepId>
    </ResultScriptConfigDisplay>
    <ResultScriptConfigDisplay>
      <Initial>true</Initial>
      <InputValue>sample string 3</InputValue>
      <ReportName>sample string 1</ReportName>
      <ScriptStepCode>sample string 2</ScriptStepCode>
      <ScriptStepId>1</ScriptStepId>
    </ResultScriptConfigDisplay>
  </conifgs>
</ResultForScriptConfigChange>