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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class NCESDropdown
    {
        public virtual long ID { get; set; }
        public virtual string Name { get; set; }
    }

    public partial class NCESGetDropdownsRequest
    {
        public virtual int StateID { get; set; }
        public virtual int CountyID { get; set; }
        public virtual int DistrictID { get; set; }
    }

    public partial class NCESGetDropdownsResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<NCESDropdown> Dropdowns { get; set; } = [];
    }

}

C# 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
		}
	]
}