digitaluapi

<back to all web services

BatchViewQuery

The following routes are available for this service:
GET/batch_view
GET/batch_view/{Id}
BatchViewQuery Parameters:
NameParameterData TypeRequiredDescription
UserAuthIdqueryintNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
BatchView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
CreatedDateformDateTimeOffset?No
FileNameformstringNo
FileSizeformstringNo
RecordCountformint?No
UserAuthIdformint?No
RowVersionGuidformGuidNo
InsertedRecordsformint?No
UpdatedRecordsformint?No
DeletedRecordsformint?No
UploadTypeformstringNo
StatusCodesIdformlong?No
StatusCodeDescriptionformstringNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<CampaignCustomersView>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo
CampaignCustomersView Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
NameformstringNo
DescriptionformstringNo
CustomersIdformlong?No
FirstNameformstringNo
LastNameformstringNo
IdNumberformstringNo
PassportNumberformstringNo
EmailformstringNo
MobileNumberformstringNo
CustomerUniqueIdentifierformstringNo
CustomerPublicAccessGuidformGuid?No
CampaignPublicAccessGuidformGuid?No
TenantsIdformint?No

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.

GET /batch_view HTTP/1.1 
Host: duengageapi.uat.scadsoftware.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			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,
			StatusCodeDescription: String
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}