digitaluapi

<back to all web services

DeleteBatchAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/delete_batch
"use strict";
export class DeleteBatchAddResponse {
    /** @param {{CreatedDate?:string,FileName?:string,FileSize?:string,RecordCount?:number,FieldMapping?:string,UserAuthId?:number,RowVersionGuid?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    CreatedDate;
    /** @type {string} */
    FileName;
    /** @type {string} */
    FileSize;
    /** @type {number} */
    RecordCount;
    /** @type {string} */
    FieldMapping;
    /** @type {?number} */
    UserAuthId;
    /** @type {string} */
    RowVersionGuid;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class DeleteBatchAdd {
    /** @param {{CreatedDate?:string,FileName?:string,FileSize?:string,RecordCount?:number,FieldMapping?:string,UserAuthId?:number,RowVersionGuid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    CreatedDate;
    /** @type {string} */
    FileName;
    /** @type {string} */
    FileSize;
    /** @type {number} */
    RecordCount;
    /** @type {string} */
    FieldMapping;
    /** @type {?number} */
    UserAuthId;
    /** @type {string} */
    RowVersionGuid;
}

JavaScript DeleteBatchAdd DTOs

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

HTTP + JSV

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

POST /delete_batch HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CreatedDate: 0001-01-01,
	FileName: String,
	FileSize: String,
	RecordCount: 0,
	FieldMapping: String,
	UserAuthId: 0,
	RowVersionGuid: 00000000000000000000000000000000
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CreatedDate: 0001-01-01,
	FileName: String,
	FileSize: String,
	RecordCount: 0,
	FieldMapping: String,
	UserAuthId: 0,
	RowVersionGuid: 00000000000000000000000000000000,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}