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}
import Foundation
import ServiceStack

public class orgGetSingleRequest : Codable
{
    public var schoolID:Int
    public var districtID:Int

    required public init(){}
}

public class orgGetSingleResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var org:Organization

    required public init(){}
}

public class Organization : Codable
{
    public var organizationId:Int
    public var organizationTypeId:Int
    public var stateID:Int
    public var stateName:String
    public var districtID:Int
    public var districtName:String
    public var countyID:Int
    public var countyName:String
    public var schoolID:Int
    public var schoolName:String
    public var entityName:String
    public var entityId:String
    public var source:String
    public var pera_ListId:Int

    required public init(){}
}


Swift 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}}