| GET | /batch_data_fields_view | ||
|---|---|---|---|
| GET | /batch_data_fields_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 BatchDataFieldsView
{
public Id?: number;
public BatchId?: number;
public UploadFieldsId?: number;
public MappedFieldName: string;
public FieldName: string;
public Required: boolean;
public UploadType: string;
public Label: string;
public UploadSubtype: string;
public IsEnabled: boolean;
public SortOrder?: number;
public Help: string;
public Placeholder: string;
public DataType: string;
public constructor(init?: Partial<BatchDataFieldsView>) { (Object as any).assign(this, init); }
}
// @DataContract
export class BatchDataFieldsViewQuery extends QueryDb<BatchDataFieldsView> implements IGet
{
public constructor(init?: Partial<BatchDataFieldsViewQuery>) { 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 BatchDataFieldsViewQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /batch_data_fields_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,
BatchId: 0,
UploadFieldsId: 0,
MappedFieldName: String,
FieldName: String,
Required: False,
UploadType: String,
Label: String,
UploadSubtype: String,
IsEnabled: False,
SortOrder: 0,
Help: String,
Placeholder: String,
DataType: String
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}