Trendsic Platform Service

<back to all web services

schoolSearchRequest

The following routes are available for this service:
GET,OPTIONS/v1/schoolSearch/{schoolName}
schoolSearchRequest Parameters:
NameParameterData TypeRequiredDescription
schoolNamepathstringNo
schoolSearchResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
schoolsformList<OrganizationDropdown>No
OrganizationDropdown Parameters:
NameParameterData TypeRequiredDescription
IDformstringNo
NameformstringNo

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

HTTP + JSV

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