regis

<back to all web services

CRMLeadSearchRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/DynamicsCRM/Lead/Search
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class CRMLeadResponse implements IConvertible
{
    ResponseStatus? responseStatus;
    String? guid;
    String? first_name;
    String? last_name;
    String? middle_name;
    String? preferred_name;
    String? former_name;
    String? prefix;
    String? spouse_name;
    String? addr1;
    String? addr2;
    String? city;
    String? state;
    String? country;
    String? code;
    String? citizenship;
    String? citizenship_other;
    String? permanent_resident;
    DateTime? dob;
    String? denomination;
    String? gender;
    String? marital_status;
    bool? send_admissions_marketing_materials;
    String? email;
    String? email_secondary;
    String? phone_home;
    String? phone_bus;
    String? phone_cell;
    String? added_by;
    DateTime? added_date;
    String? changed_by;
    DateTime? changed_date;
    String? owner_full_name;

    CRMLeadResponse({this.responseStatus,this.guid,this.first_name,this.last_name,this.middle_name,this.preferred_name,this.former_name,this.prefix,this.spouse_name,this.addr1,this.addr2,this.city,this.state,this.country,this.code,this.citizenship,this.citizenship_other,this.permanent_resident,this.dob,this.denomination,this.gender,this.marital_status,this.send_admissions_marketing_materials,this.email,this.email_secondary,this.phone_home,this.phone_bus,this.phone_cell,this.added_by,this.added_date,this.changed_by,this.changed_date,this.owner_full_name});
    CRMLeadResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        guid = json['guid'];
        first_name = json['first_name'];
        last_name = json['last_name'];
        middle_name = json['middle_name'];
        preferred_name = json['preferred_name'];
        former_name = json['former_name'];
        prefix = json['prefix'];
        spouse_name = json['spouse_name'];
        addr1 = json['addr1'];
        addr2 = json['addr2'];
        city = json['city'];
        state = json['state'];
        country = json['country'];
        code = json['code'];
        citizenship = json['citizenship'];
        citizenship_other = json['citizenship_other'];
        permanent_resident = json['permanent_resident'];
        dob = JsonConverters.fromJson(json['dob'],'DateTime',context!);
        denomination = json['denomination'];
        gender = json['gender'];
        marital_status = json['marital_status'];
        send_admissions_marketing_materials = json['send_admissions_marketing_materials'];
        email = json['email'];
        email_secondary = json['email_secondary'];
        phone_home = json['phone_home'];
        phone_bus = json['phone_bus'];
        phone_cell = json['phone_cell'];
        added_by = json['added_by'];
        added_date = JsonConverters.fromJson(json['added_date'],'DateTime',context!);
        changed_by = json['changed_by'];
        changed_date = JsonConverters.fromJson(json['changed_date'],'DateTime',context!);
        owner_full_name = json['owner_full_name'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!),
        'guid': guid,
        'first_name': first_name,
        'last_name': last_name,
        'middle_name': middle_name,
        'preferred_name': preferred_name,
        'former_name': former_name,
        'prefix': prefix,
        'spouse_name': spouse_name,
        'addr1': addr1,
        'addr2': addr2,
        'city': city,
        'state': state,
        'country': country,
        'code': code,
        'citizenship': citizenship,
        'citizenship_other': citizenship_other,
        'permanent_resident': permanent_resident,
        'dob': JsonConverters.toJson(dob,'DateTime',context!),
        'denomination': denomination,
        'gender': gender,
        'marital_status': marital_status,
        'send_admissions_marketing_materials': send_admissions_marketing_materials,
        'email': email,
        'email_secondary': email_secondary,
        'phone_home': phone_home,
        'phone_bus': phone_bus,
        'phone_cell': phone_cell,
        'added_by': added_by,
        'added_date': JsonConverters.toJson(added_date,'DateTime',context!),
        'changed_by': changed_by,
        'changed_date': JsonConverters.toJson(changed_date,'DateTime',context!),
        'owner_full_name': owner_full_name
    };

    getTypeName() => "CRMLeadResponse";
    TypeContext? context = _ctx;
}

class CRMLeadSearchRequest implements IConvertible
{
    String? email;

    CRMLeadSearchRequest({this.email});
    CRMLeadSearchRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        email = json['email'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'email': email
    };

    getTypeName() => "CRMLeadSearchRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'data.regent_college.edu', types: <String, TypeInfo> {
    'CRMLeadResponse': TypeInfo(TypeOf.Class, create:() => CRMLeadResponse()),
    'CRMLeadSearchRequest': TypeInfo(TypeOf.Class, create:() => CRMLeadSearchRequest()),
});

Dart CRMLeadSearchRequest DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /DynamicsCRM/Lead/Search HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"email":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"guid":"String","first_name":"String","last_name":"String","middle_name":"String","preferred_name":"String","former_name":"String","prefix":"String","spouse_name":"String","addr1":"String","addr2":"String","city":"String","state":"String","country":"String","code":"String","citizenship":"String","citizenship_other":"String","permanent_resident":"String","dob":"0001-01-01T00:00:00.0000000","denomination":"String","gender":"String","marital_status":"String","send_admissions_marketing_materials":false,"email":"String","email_secondary":"String","phone_home":"String","phone_bus":"String","phone_cell":"String","added_by":"String","added_date":"0001-01-01T00:00:00.0000000","changed_by":"String","changed_date":"0001-01-01T00:00:00.0000000","owner_full_name":"String"}