| Requires any of the roles: | Client, Admin, Partner |
| POST | /batch |
|---|
export class Batch
{
// @DataMember(Order=1)
// @Required()
public Id: number;
// @DataMember(Order=2)
public CreatedDate?: string;
// @DataMember(Order=3)
// @Required()
public FileName: string;
// @DataMember(Order=4)
// @Required()
public FileSize: string;
// @DataMember(Order=5)
// @Required()
public RecordCount: number;
// @DataMember(Order=6)
public UserAuthId: number;
// @DataMember(Order=7)
public RowVersionGuid: string;
// @DataMember(Order=8)
public InsertedRecords?: number;
// @DataMember(Order=9)
public UpdatedRecords?: number;
// @DataMember(Order=10)
public DeletedRecords?: number;
// @DataMember(Order=11)
public UploadType: string;
// @DataMember(Order=12)
public StatusCodesId?: number;
// @DataMember(Order=13)
public ErrorRecords?: number;
public constructor(init?: Partial<Batch>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BatchAdd
{
// @DataMember(Order=2)
public CreatedDate?: string;
// @DataMember(Order=3)
// @Validate(Validator="NotNull")
public FileName: string;
// @DataMember(Order=4)
// @Validate(Validator="NotNull")
public FileSize: string;
// @DataMember(Order=5)
// @Validate(Validator="NotNull")
public RecordCount: number;
// @DataMember(Order=6)
public UserAuthId?: number;
// @DataMember(Order=7)
public RowVersionGuid?: string;
// @DataMember(Order=8)
public InsertedRecords?: number;
// @DataMember(Order=9)
public UpdatedRecords?: number;
// @DataMember(Order=10)
public DeletedRecords?: number;
// @DataMember(Order=11)
public UploadType: string;
// @DataMember(Order=12)
public StatusCodesId?: number;
public constructor(init?: Partial<BatchAdd>) { (Object as any).assign(this, init); }
}
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>