Trendsic Platform Service

<back to all web services

OrganizationRequest

Requires Authentication
Requires any of the roles:Agent, Administrator, Agent, Administrator, Agent, Administrator, Agent, Administrator
The following routes are available for this service:
GET,POST,PUT,DELETE,OPTIONS/v1/Organization/{OrganizationId}
GET,POST,PUT,DELETE,OPTIONS/v1/Organization
"use strict";
export class Organization {
    /** @param {{OrganizationId?:number,OrganizationTypeId?:number,StateID?:number,StateName?:string,DistrictID?:number,DistrictName?:string,CountyID?:number,CountyName?:string,SchoolID?:number,SchoolName?:string,EntityName?:string,EntityId?:string,Source?:string,Pera_ListId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    OrganizationId;
    /** @type {number} */
    OrganizationTypeId;
    /** @type {number} */
    StateID;
    /** @type {string} */
    StateName;
    /** @type {number} */
    DistrictID;
    /** @type {string} */
    DistrictName;
    /** @type {number} */
    CountyID;
    /** @type {string} */
    CountyName;
    /** @type {number} */
    SchoolID;
    /** @type {string} */
    SchoolName;
    /** @type {string} */
    EntityName;
    /** @type {string} */
    EntityId;
    /** @type {string} */
    Source;
    /** @type {number} */
    Pera_ListId;
}
export class OrganizationResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Organization?:Organization[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {Organization[]} */
    Organization = [];
}
export class OrganizationRequest {
    /** @param {{Organization?:Organization[],OrganizationId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Organization[]} */
    Organization = [];
    /** @type {number} */
    OrganizationId;
}

JavaScript OrganizationRequest 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.

POST /v1/Organization/{OrganizationId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Organization: 
	[
		{
			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
		}
	],
	OrganizationId: 0
}
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
		}
	},
	Organization: 
	[
		{
			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
		}
	]
}