digitaluapi

<back to all web services

BatchEdit

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
PUT/batch/{Id}
"use strict";
export class BatchEditResponse {
    /** @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,ResponseStatus?:ResponseStatus}} [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 {ResponseStatus} */
    ResponseStatus;
}
export class BatchEdit {
    /** @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}} [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;
}

JavaScript BatchEdit DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /batch/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BatchEdit xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel">
  <Id>0</Id>
  <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>
</BatchEdit>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<BatchEditResponse 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>
  <DeletedRecords>0</DeletedRecords>
  <FileName>String</FileName>
  <FileSize>String</FileSize>
  <Id>0</Id>
  <InsertedRecords>0</InsertedRecords>
  <RecordCount>0</RecordCount>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <RowVersionGuid>00000000-0000-0000-0000-000000000000</RowVersionGuid>
  <StatusCodesId>0</StatusCodesId>
  <UpdatedRecords>0</UpdatedRecords>
  <UploadType>String</UploadType>
  <UserAuthId>0</UserAuthId>
</BatchEditResponse>