digitaluapi

<back to all web services

BatchViewQuery

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

public class BatchViewQuery : QueryDb<BatchView>, IGet
{
    public var userAuthId:Int

    required public init(){ super.init() }

    private enum CodingKeys : String, CodingKey {
        case userAuthId
    }

    required public init(from decoder: Decoder) throws {
        try super.init(from: decoder)
        let container = try decoder.container(keyedBy: CodingKeys.self)
        userAuthId = try container.decodeIfPresent(Int.self, forKey: .userAuthId)
    }

    public override func encode(to encoder: Encoder) throws {
        try super.encode(to: encoder)
        var container = encoder.container(keyedBy: CodingKeys.self)
        if userAuthId != nil { try container.encode(userAuthId, forKey: .userAuthId) }
    }
}

public class BatchView : Codable
{
    public var id:Int?
    public var createdDate:Date?
    public var fileName:String
    public var fileSize:String
    public var recordCount:Int?
    public var userAuthId:Int?
    public var rowVersionGuid:String
    public var insertedRecords:Int?
    public var updatedRecords:Int?
    public var deletedRecords:Int?
    public var uploadType:String
    public var statusCodesId:Int?
    public var statusCodeDescription:String

    required public init(){}
}

public class CampaignCustomersView : Codable
{
    // @DataMember(Order=1)
    public var id:Int?

    // @DataMember(Order=2)
    public var name:String

    // @DataMember(Order=3)
    public var Description:String

    // @DataMember(Order=4)
    public var customersId:Int?

    // @DataMember(Order=5)
    public var firstName:String

    // @DataMember(Order=6)
    public var lastName:String

    // @DataMember(Order=7)
    public var idNumber:String

    // @DataMember(Order=8)
    public var passportNumber:String

    // @DataMember(Order=9)
    public var email:String

    // @DataMember(Order=10)
    public var mobileNumber:String

    // @DataMember(Order=11)
    public var customerUniqueIdentifier:String

    // @DataMember(Order=12)
    public var customerPublicAccessGuid:String?

    // @DataMember(Order=13)
    public var campaignPublicAccessGuid:String?

    // @DataMember(Order=14)
    public var tenantsId:Int?

    required public init(){}
}


Swift BatchViewQuery DTOs

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>