| Requires any of the roles: | Client, Admin, Partner |
| POST | /batch |
|---|
"use strict";
export class Batch {
/** @param {{Id?:number,CreatedDate?:string,FileName?:string,FileSize?:string,RecordCount?:number,UserAuthId?:number,RowVersionGuid?:string,InsertedRecords?:number,UpdatedRecords?:number,DeletedRecords?:number,UploadType?:string,StatusCodesId?:number,ErrorRecords?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {?string} */
CreatedDate;
/** @type {string} */
FileName;
/** @type {string} */
FileSize;
/** @type {number} */
RecordCount;
/** @type {number} */
UserAuthId;
/** @type {string} */
RowVersionGuid;
/** @type {?number} */
InsertedRecords;
/** @type {?number} */
UpdatedRecords;
/** @type {?number} */
DeletedRecords;
/** @type {string} */
UploadType;
/** @type {?number} */
StatusCodesId;
/** @type {?number} */
ErrorRecords;
}
export class BatchAdd {
/** @param {{CreatedDate?:string,FileName?:string,FileSize?:string,RecordCount?:number,UserAuthId?:number,RowVersionGuid?:string,InsertedRecords?:number,UpdatedRecords?:number,DeletedRecords?:number,UploadType?:string,StatusCodesId?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
CreatedDate;
/** @type {string} */
FileName;
/** @type {string} */
FileSize;
/** @type {number} */
RecordCount;
/** @type {?number} */
UserAuthId;
/** @type {?string} */
RowVersionGuid;
/** @type {?number} */
InsertedRecords;
/** @type {?number} */
UpdatedRecords;
/** @type {?number} */
DeletedRecords;
/** @type {string} */
UploadType;
/** @type {?number} */
StatusCodesId;
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /batch HTTP/1.1
Host: duengageapi.uat.scadsoftware.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<BatchAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
<CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</CreatedDate>
<FileName>String</FileName>
<FileSize>String</FileSize>
<RecordCount>0</RecordCount>
<UserAuthId>0</UserAuthId>
<RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
<InsertedRecords>0</InsertedRecords>
<UpdatedRecords>0</UpdatedRecords>
<DeletedRecords>0</DeletedRecords>
<UploadType>String</UploadType>
<StatusCodesId>0</StatusCodesId>
</BatchAdd>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<Batch xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
<CreatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</CreatedDate>
<DeletedRecords>0</DeletedRecords>
<ErrorRecords>0</ErrorRecords>
<FileName>String</FileName>
<FileSize>String</FileSize>
<Id>0</Id>
<InsertedRecords>0</InsertedRecords>
<RecordCount>0</RecordCount>
<RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
<StatusCodesId>0</StatusCodesId>
<UpdatedRecords>0</UpdatedRecords>
<UploadType>String</UploadType>
<UserAuthId>0</UserAuthId>
</Batch>