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}
"use strict";
export class Organization {
    /** @param {{OrganizationId?:number,OrganizationTypeId?:number,StateID?:number,StateName?:string,DistrictID?:number,DistrictName?:string,CountyID?:number,CountyName?:string,SchoolID?:number,SchoolName?:string,EntityName?:string,EntityId?:string,Source?:string,Pera_ListId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    OrganizationId;
    /** @type {number} */
    OrganizationTypeId;
    /** @type {number} */
    StateID;
    /** @type {string} */
    StateName;
    /** @type {number} */
    DistrictID;
    /** @type {string} */
    DistrictName;
    /** @type {number} */
    CountyID;
    /** @type {string} */
    CountyName;
    /** @type {number} */
    SchoolID;
    /** @type {string} */
    SchoolName;
    /** @type {string} */
    EntityName;
    /** @type {string} */
    EntityId;
    /** @type {string} */
    Source;
    /** @type {number} */
    Pera_ListId;
}
export class orgGetSingleResponse {
    /** @param {{ResponseStatus?:ResponseStatus,org?:Organization}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Organization} */
    org;
}
export class orgGetSingleRequest {
    /** @param {{schoolID?:number,districtID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    schoolID;
    /** @type {number} */
    districtID;
}

JavaScript orgGetSingleRequest 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/Organization/GetSingleBySchoolID/{schoolID} 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"}},"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}}