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}

export class BatchEditResponse
{
    // @DataMember(Order=1)
    public Id: number;

    // @DataMember(Order=2)
    public CreatedDate?: string;

    // @DataMember(Order=3)
    public FileName: string;

    // @DataMember(Order=4)
    public FileSize: string;

    // @DataMember(Order=5)
    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=14)
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<BatchEditResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BatchEdit
{
    // @DataMember(Order=1)
    // @Validate(Validator="NotNull")
    public Id: number;

    // @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<BatchEdit>) { (Object as any).assign(this, init); }
}

TypeScript BatchEdit 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.

PUT /batch/{Id} HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/csv
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}
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,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}