POST api/WI/CreateBatchFiles

Request Information

URI Parameters

None.

Body Parameters

BatchFilesRequest
NameDescriptionTypeAdditional information
aBatchFiles

Collection of OneBatchFileRequest

None.

sBatchIdsSeparateByCommas

string

None.

authUser

AuthUser

None.

Request Formats

application/json, text/json

Sample:
{
  "aBatchFiles": [
    {
      "FacilityID": "sample string 1",
      "UTCStartDate": "2025-06-24T01:37:56.8508542-05:00",
      "UTCEndDate": "2025-06-24T01:37:56.8508542-05:00"
    },
    {
      "FacilityID": "sample string 1",
      "UTCStartDate": "2025-06-24T01:37:56.8508542-05:00",
      "UTCEndDate": "2025-06-24T01:37:56.8508542-05:00"
    }
  ],
  "sBatchIdsSeparateByCommas": "sample string 1",
  "authUser": {
    "userid": "sample string 1",
    "password": "sample string 2"
  }
}

application/xml, text/xml

Sample:
<BatchFilesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CNCWrapperBased">
  <authUser>
    <password>sample string 2</password>
    <userid>sample string 1</userid>
  </authUser>
  <aBatchFiles>
    <BatchFilesRequest.OneBatchFileRequest>
      <FacilityID>sample string 1</FacilityID>
      <UTCEndDate>2025-06-24T01:37:56.8508542-05:00</UTCEndDate>
      <UTCStartDate>2025-06-24T01:37:56.8508542-05:00</UTCStartDate>
    </BatchFilesRequest.OneBatchFileRequest>
    <BatchFilesRequest.OneBatchFileRequest>
      <FacilityID>sample string 1</FacilityID>
      <UTCEndDate>2025-06-24T01:37:56.8508542-05:00</UTCEndDate>
      <UTCStartDate>2025-06-24T01:37:56.8508542-05:00</UTCStartDate>
    </BatchFilesRequest.OneBatchFileRequest>
  </aBatchFiles>
  <sBatchIdsSeparateByCommas>sample string 1</sBatchIdsSeparateByCommas>
</BatchFilesRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'BatchFilesRequest'.

Response Information

Resource Description

BatchFilesReponse
NameDescriptionTypeAdditional information
aResponses

Collection of OneBatchResponse

None.

sErrorMsg

string

None.

bHasError

boolean

None.

nErrorCode

integer

None.

totalMillisecs

integer

None.

enErrorCode

enERROR

None.

lTransactionId

integer

None.

Response Formats

application/json, text/json

Sample:
{
  "aResponses": [
    {
      "FacilityID": "sample string 1",
      "sErrorMessage": "sample string 2",
      "nErrorCode": 0,
      "bHasError": true,
      "sFtpFileName": "sample string 5",
      "recsChanged": 6,
      "bReadBackFtpFileOkayed": true,
      "UTCStartDate": "2025-06-24T01:37:57.0828662-05:00",
      "UTCEndDate": "2025-06-24T01:37:57.0828662-05:00",
      "sContentsSFTP": [
        "sample string 1",
        "sample string 2"
      ],
      "enErrorCode": 0
    },
    {
      "FacilityID": "sample string 1",
      "sErrorMessage": "sample string 2",
      "nErrorCode": 0,
      "bHasError": true,
      "sFtpFileName": "sample string 5",
      "recsChanged": 6,
      "bReadBackFtpFileOkayed": true,
      "UTCStartDate": "2025-06-24T01:37:57.0828662-05:00",
      "UTCEndDate": "2025-06-24T01:37:57.0828662-05:00",
      "sContentsSFTP": [
        "sample string 1",
        "sample string 2"
      ],
      "enErrorCode": 0
    }
  ],
  "sErrorMsg": "sample string 1",
  "bHasError": true,
  "nErrorCode": 0,
  "totalMillisecs": 4,
  "enErrorCode": 0,
  "lTransactionId": 5
}

application/xml, text/xml

Sample:
<BatchFilesReponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CNCWrapperBased">
  <bHasError>true</bHasError>
  <enErrorCode>NO_ERROR</enErrorCode>
  <lTransactionId>5</lTransactionId>
  <nErrorCode>0</nErrorCode>
  <sErrorMsg>sample string 1</sErrorMsg>
  <totalMillisecs>4</totalMillisecs>
  <aResponses>
    <BatchFilesReponse.OneBatchResponse>
      <FacilityID>sample string 1</FacilityID>
      <UTCEndDate>2025-06-24T01:37:57.0828662-05:00</UTCEndDate>
      <UTCStartDate>2025-06-24T01:37:57.0828662-05:00</UTCStartDate>
      <bHasError>true</bHasError>
      <bReadBackFtpFileOkayed>true</bReadBackFtpFileOkayed>
      <enErrorCode>NO_ERROR</enErrorCode>
      <nErrorCode>0</nErrorCode>
      <recsChanged>6</recsChanged>
      <sContentsSFTP xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </sContentsSFTP>
      <sErrorMessage>sample string 2</sErrorMessage>
      <sFtpFileName>sample string 5</sFtpFileName>
    </BatchFilesReponse.OneBatchResponse>
    <BatchFilesReponse.OneBatchResponse>
      <FacilityID>sample string 1</FacilityID>
      <UTCEndDate>2025-06-24T01:37:57.0828662-05:00</UTCEndDate>
      <UTCStartDate>2025-06-24T01:37:57.0828662-05:00</UTCStartDate>
      <bHasError>true</bHasError>
      <bReadBackFtpFileOkayed>true</bReadBackFtpFileOkayed>
      <enErrorCode>NO_ERROR</enErrorCode>
      <nErrorCode>0</nErrorCode>
      <recsChanged>6</recsChanged>
      <sContentsSFTP xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>sample string 1</d4p1:string>
        <d4p1:string>sample string 2</d4p1:string>
      </sContentsSFTP>
      <sErrorMessage>sample string 2</sErrorMessage>
      <sFtpFileName>sample string 5</sFtpFileName>
    </BatchFilesReponse.OneBatchResponse>
  </aResponses>
</BatchFilesReponse>