Trendsic Platform Service

<back to all web services

NCESGetDropdownsRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET/v1/NCES/GetDropdowns
GET/v1/NCES/GetDropdowns/{StateID}
GET/v1/NCES/GetDropdowns/{StateID}/{CountyID}/{DistrictID}
GET/v1/NCES/GetDropdowns/{StateID}/{CountyID}
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 NCESDropdown() = 
        member val ID:Int64 = new Int64() with get,set
        member val Name:String = null with get,set

    [<AllowNullLiteral>]
    type NCESGetDropdownsResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Dropdowns:ResizeArray<NCESDropdown> = new ResizeArray<NCESDropdown>() with get,set

    [<AllowNullLiteral>]
    type NCESGetDropdownsRequest() = 
        member val StateID:Int32 = new Int32() with get,set
        member val CountyID:Int32 = new Int32() with get,set
        member val DistrictID:Int32 = new Int32() with get,set

F# NCESGetDropdownsRequest 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/NCES/GetDropdowns 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
		}
	},
	Dropdowns: 
	[
		{
			ID: 0,
			Name: String
		}
	]
}