Trendsic Platform Service

<back to all web services

schoolSearchRequest

The following routes are available for this service:
GET,OPTIONS/v1/schoolSearch/{schoolName}
"use strict";
export class OrganizationDropdown {
    /** @param {{ID?:string,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    ID;
    /** @type {string} */
    Name;
}
export class schoolSearchResponse {
    /** @param {{ResponseStatus?:ResponseStatus,schools?:OrganizationDropdown[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {OrganizationDropdown[]} */
    schools = [];
}
export class schoolSearchRequest {
    /** @param {{schoolName?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    schoolName;
}

JavaScript schoolSearchRequest DTOs

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

HTTP + OTHER

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: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}]}