digitaluapi

<back to all web services

BatchLookup

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

JavaScript BatchLookup DTOs

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

HTTP + CSV

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

GET /batch HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

[{"CreatedDate":"0001-01-01T00:00:00.0000000+00:00","FileName":"String","FileSize":"String","RecordCount":0,"UserAuthId":0,"RowVersionGuid":"00000000000000000000000000000000","InsertedRecords":0,"UpdatedRecords":0,"DeletedRecords":0,"UploadType":"String","StatusCodesId":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}]