digitaluapi

BatchViewQuery

The following routes are available for this service:
GET	/batch_view
GET	/batch_view/{Id}

**BatchViewQuery** Parameters:
Name	Parameter	Data Type	Required	Description
UserAuthId	query	int	No

**QueryBase** Parameters:
Name	Parameter	Data Type	Required
Skip	form	int?	No
Take	form	int?	No
OrderBy	form	string	No
OrderByDesc	form	string	No
Include	form	string	No
Fields	form	string	No
Meta	form	Dictionary<string, string>	No

**BatchView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
CreatedDate	form	DateTimeOffset?	No
FileName	form	string	No
FileSize	form	string	No
RecordCount	form	int?	No
UserAuthId	form	int?	No
RowVersionGuid	form	Guid	No
InsertedRecords	form	int?	No
UpdatedRecords	form	int?	No
DeletedRecords	form	int?	No
UploadType	form	string	No
StatusCodesId	form	long?	No
StatusCodeDescription	form	string	No

**QueryResponse<T>** Parameters:
Name	Parameter	Data Type	Required
Offset	form	int	No
Total	form	int	No
Results	form	List<CampaignCustomersView>	No
Meta	form	Dictionary<string, string>	No
ResponseStatus	form	ResponseStatus	No

**CampaignCustomersView** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
Name	form	string	No
Description	form	string	No
CustomersId	form	long?	No
FirstName	form	string	No
LastName	form	string	No
IdNumber	form	string	No
PassportNumber	form	string	No
Email	form	string	No
MobileNumber	form	string	No
CustomerUniqueIdentifier	form	string	No
CustomerPublicAccessGuid	form	Guid?	No
CampaignPublicAccessGuid	form	Guid?	No
TenantsId	form	int?	No

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

HTTP + XML

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: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfBatchViewqTGWvAI3 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/digitaluapi.ServiceModel.Types">
    <d2p1:BatchView>
      <d2p1:CreatedDate xmlns:d4p1="http://schemas.datacontract.org/2004/07/System">
        <d4p1:DateTime>0001-01-01T00:00:00Z</d4p1:DateTime>
        <d4p1:OffsetMinutes>0</d4p1:OffsetMinutes>
      </d2p1:CreatedDate>
      <d2p1:DeletedRecords>0</d2p1:DeletedRecords>
      <d2p1:FileName>String</d2p1:FileName>
      <d2p1:FileSize>String</d2p1:FileSize>
      <d2p1:Id>0</d2p1:Id>
      <d2p1:InsertedRecords>0</d2p1:InsertedRecords>
      <d2p1:RecordCount>0</d2p1:RecordCount>
      <d2p1:RowVersionGuid>00000000-0000-0000-0000-000000000000</d2p1:RowVersionGuid>
      <d2p1:StatusCodeDescription>String</d2p1:StatusCodeDescription>
      <d2p1:StatusCodesId>0</d2p1:StatusCodesId>
      <d2p1:UpdatedRecords>0</d2p1:UpdatedRecords>
      <d2p1:UploadType>String</d2p1:UploadType>
      <d2p1:UserAuthId>0</d2p1:UserAuthId>
    </d2p1:BatchView>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Meta>
      </ResponseError>
    </Errors>
    <Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </Meta>
  </ResponseStatus>
</QueryResponseOfBatchViewqTGWvAI3>