Trendsic Platform Service

<back to all web services

schoolSearchRequest

The following routes are available for this service:
GET,OPTIONS/v1/schoolSearch/{schoolName}

export class OrganizationDropdown
{
    public ID: string;
    public Name: string;

    public constructor(init?: Partial<OrganizationDropdown>) { (Object as any).assign(this, init); }
}

export class schoolSearchResponse
{
    public ResponseStatus: ResponseStatus;
    public schools: OrganizationDropdown[] = [];

    public constructor(init?: Partial<schoolSearchResponse>) { (Object as any).assign(this, init); }
}

export class schoolSearchRequest
{
    public schoolName: string;

    public constructor(init?: Partial<schoolSearchRequest>) { (Object as any).assign(this, init); }
}

TypeScript schoolSearchRequest 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.

GET /v1/schoolSearch/{schoolName} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
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"}},"schools":[{"ID":"String","Name":"String"}]}