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 .xml suffix or ?format=xml

HTTP + XML

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/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<orgGetSingleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <org>
    <CountyID>0</CountyID>
    <CountyName>String</CountyName>
    <DistrictID>0</DistrictID>
    <DistrictName>String</DistrictName>
    <EntityId>String</EntityId>
    <EntityName>String</EntityName>
    <OrganizationId>0</OrganizationId>
    <OrganizationTypeId>0</OrganizationTypeId>
    <Pera_ListId>0</Pera_ListId>
    <SchoolID>0</SchoolID>
    <SchoolName>String</SchoolName>
    <Source>String</Source>
    <StateID>0</StateID>
    <StateName>String</StateName>
  </org>
</orgGetSingleResponse>