Trendsic Platform Service

<back to all web services

orgGetSingleRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator
The following routes are available for this service:
GET, OPTIONS/v1/Organization/GetSingleBySchoolID/{schoolID}
GET, OPTIONS/v1/Organization/GetSingleByDistrictID/{districtID}
orgGetSingleRequest Parameters:
NameParameterData TypeRequiredDescription
schoolIDpathlongNo
districtIDpathintNo
orgGetSingleResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
orgformOrganizationNo
Organization Parameters:
NameParameterData TypeRequiredDescription
OrganizationIdformlongNo
OrganizationTypeIdformintNo
StateIDformintNo
StateNameformstringNo
DistrictIDformintNo
DistrictNameformstringNo
CountyIDformintNo
CountyNameformstringNo
SchoolIDformlongNo
SchoolNameformstringNo
EntityNameformstringNo
EntityIdformstringNo
SourceformstringNo
Pera_ListIdformintNo

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/Organization/GetSingleBySchoolID/{schoolID} 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
		}
	},
	org: 
	{
		OrganizationId: 0,
		OrganizationTypeId: 0,
		StateID: 0,
		StateName: String,
		DistrictID: 0,
		DistrictName: String,
		CountyID: 0,
		CountyName: String,
		SchoolID: 0,
		SchoolName: String,
		EntityName: String,
		EntityId: String,
		Source: String,
		Pera_ListId: 0
	}
}