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}

export class Organization
{
    public OrganizationId: number;
    public OrganizationTypeId: number;
    public StateID: number;
    public StateName: string;
    public DistrictID: number;
    public DistrictName: string;
    public CountyID: number;
    public CountyName: string;
    public SchoolID: number;
    public SchoolName: string;
    public EntityName: string;
    public EntityId: string;
    public Source: string;
    public Pera_ListId: number;

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

export class orgGetSingleResponse
{
    public ResponseStatus: ResponseStatus;
    public org: Organization;

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

export class orgGetSingleRequest
{
    public schoolID: number;
    public districtID: number;

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

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