| GET | /batch_view | ||
|---|---|---|---|
| GET | /batch_view/{Id} |
// @DataContract
export class QueryBase
{
// @DataMember(Order=1)
public Skip?: number;
// @DataMember(Order=2)
public Take?: number;
// @DataMember(Order=3)
public OrderBy: string;
// @DataMember(Order=4)
public OrderByDesc: string;
// @DataMember(Order=5)
public Include: string;
// @DataMember(Order=6)
public Fields: string;
// @DataMember(Order=7)
public Meta: { [index:string]: string; };
public constructor(init?: Partial<QueryBase>) { (Object as any).assign(this, init); }
}
export class QueryDb<T> extends QueryBase
{
public constructor(init?: Partial<QueryDb<T>>) { super(init); (Object as any).assign(this, init); }
}
export class BatchView
{
public Id?: number;
public CreatedDate?: string;
public FileName: string;
public FileSize: string;
public RecordCount?: number;
public UserAuthId?: number;
public RowVersionGuid: string;
public InsertedRecords?: number;
public UpdatedRecords?: number;
public DeletedRecords?: number;
public UploadType: string;
public StatusCodesId?: number;
public StatusCodeDescription: string;
public constructor(init?: Partial<BatchView>) { (Object as any).assign(this, init); }
}
export class BatchViewQuery extends QueryDb<BatchView> implements IGet
{
public UserAuthId: number;
public constructor(init?: Partial<BatchViewQuery>) { super(init); (Object as any).assign(this, init); }
}
export class CampaignCustomersView
{
// @DataMember(Order=1)
public Id?: number;
// @DataMember(Order=2)
public Name: string;
// @DataMember(Order=3)
public Description: string;
// @DataMember(Order=4)
public CustomersId?: number;
// @DataMember(Order=5)
public FirstName: string;
// @DataMember(Order=6)
public LastName: string;
// @DataMember(Order=7)
public IdNumber: string;
// @DataMember(Order=8)
public PassportNumber: string;
// @DataMember(Order=9)
public Email: string;
// @DataMember(Order=10)
public MobileNumber: string;
// @DataMember(Order=11)
public CustomerUniqueIdentifier: string;
// @DataMember(Order=12)
public CustomerPublicAccessGuid?: string;
// @DataMember(Order=13)
public CampaignPublicAccessGuid?: string;
// @DataMember(Order=14)
public TenantsId?: number;
public constructor(init?: Partial<CampaignCustomersView>) { (Object as any).assign(this, init); }
}
// @DataContract
export class QueryResponse<T>
{
// @DataMember(Order=1)
public Offset: number;
// @DataMember(Order=2)
public Total: number;
// @DataMember(Order=3)
public Results: CampaignCustomersView[];
// @DataMember(Order=4)
public Meta: { [index:string]: string; };
// @DataMember(Order=5)
public ResponseStatus: ResponseStatus;
public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}
TypeScript BatchViewQuery DTOs
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.
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>