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}
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class Organization
            Public Overridable Property OrganizationId As Long
            Public Overridable Property OrganizationTypeId As Integer
            Public Overridable Property StateID As Integer
            Public Overridable Property StateName As String
            Public Overridable Property DistrictID As Integer
            Public Overridable Property DistrictName As String
            Public Overridable Property CountyID As Integer
            Public Overridable Property CountyName As String
            Public Overridable Property SchoolID As Long
            Public Overridable Property SchoolName As String
            Public Overridable Property EntityName As String
            Public Overridable Property EntityId As String
            Public Overridable Property Source As String
            Public Overridable Property Pera_ListId As Integer
        End Class

        Public Partial Class orgGetSingleRequest
            Public Overridable Property schoolID As Long
            Public Overridable Property districtID As Integer
        End Class

        Public Partial Class orgGetSingleResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property org As Organization
        End Class
    End Namespace
End Namespace

VB.NET 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
	}
}