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}
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Organization() = 
        member val OrganizationId:Int64 = new Int64() with get,set
        member val OrganizationTypeId:Int32 = new Int32() with get,set
        member val StateID:Int32 = new Int32() with get,set
        member val StateName:String = null with get,set
        member val DistrictID:Int32 = new Int32() with get,set
        member val DistrictName:String = null with get,set
        member val CountyID:Int32 = new Int32() with get,set
        member val CountyName:String = null with get,set
        member val SchoolID:Int64 = new Int64() with get,set
        member val SchoolName:String = null with get,set
        member val EntityName:String = null with get,set
        member val EntityId:String = null with get,set
        member val Source:String = null with get,set
        member val Pera_ListId:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type orgGetSingleResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val org:Organization = null with get,set

    [<AllowNullLiteral>]
    type orgGetSingleRequest() = 
        member val schoolID:Int64 = new Int64() with get,set
        member val districtID:Int32 = new Int32() with get,set

F# orgGetSingleRequest DTOs

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