Trendsic Platform Service

<back to all web services

schoolSearchRequest

The following routes are available for this service:
GET,OPTIONS/v1/schoolSearch/{schoolName}
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class OrganizationDropdown implements IConvertible
{
    String? ID;
    String? Name;

    OrganizationDropdown({this.ID,this.Name});
    OrganizationDropdown.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

class schoolSearchResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    List<OrganizationDropdown>? schools = [];

    schoolSearchResponse({this.ResponseStatus,this.schools});
    schoolSearchResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        schools = JsonConverters.fromJson(json['schools'],'List<OrganizationDropdown>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'schools': JsonConverters.toJson(schools,'List<OrganizationDropdown>',context!)
    };

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

class schoolSearchRequest implements IConvertible
{
    String? schoolName;

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

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

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

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'OrganizationDropdown': TypeInfo(TypeOf.Class, create:() => OrganizationDropdown()),
    'schoolSearchResponse': TypeInfo(TypeOf.Class, create:() => schoolSearchResponse()),
    'List<OrganizationDropdown>': TypeInfo(TypeOf.Class, create:() => <OrganizationDropdown>[]),
    'schoolSearchRequest': TypeInfo(TypeOf.Class, create:() => schoolSearchRequest()),
});

Dart schoolSearchRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

GET /v1/schoolSearch/{schoolName} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"schools":[{"ID":"String","Name":"String"}]}