digitaluapi

<back to all web services

BatchAdd

Requires Authentication
Requires any of the roles:Client, Admin, Partner
The following routes are available for this service:
POST/batch
BatchAdd Parameters:
NameParameterData TypeRequiredDescription
CreatedDatebodyDateTimeOffset?No
FileNamebodystringYes
FileSizebodystringYes
RecordCountbodyintYes
UserAuthIdbodyint?No
RowVersionGuidbodyGuid?No
InsertedRecordsbodyint?No
UpdatedRecordsbodyint?No
DeletedRecordsbodyint?No
UploadTypebodystringNo
StatusCodesIdbodylong?No
Batch Parameters:
NameParameterData TypeRequiredDescription
IdformlongYes
CreatedDateformDateTimeOffset?No
FileNameformstringYes
FileSizeformstringYes
RecordCountformintYes
UserAuthIdformintNo
RowVersionGuidformGuidNo
InsertedRecordsformint?No
UpdatedRecordsformint?No
DeletedRecordsformint?No
UploadTypeformstringNo
StatusCodesIdformlong?No
ErrorRecordsformint?No

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.

POST /batch HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
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}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Id":0,"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,"ErrorRecords":0}