Trendsic Platform Service

<back to all web services

DepartmentRequest

Requires Authentication
Requires any of the roles:Worker, Agent, Administrator, Administrator, Administrator, Administrator
The following routes are available for this service:
GET,POST,PUT,OPTIONS/v1/Department
GET,DELETE,OPTIONS/v1/Department/{DepartmentID}
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 Department() = 
        member val DepartmentID:Int32 = new Int32() with get,set
        member val DepartmentUID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Description:String = null with get,set
        member val Code:String = null with get,set
        member val Color:String = null with get,set
        member val Budget:Decimal = new Decimal() with get,set
        member val BillingMethod:String = null with get,set
        member val CostCenter:String = null with get,set
        member val BillingContact:String = null with get,set
        member val BillingEmail:String = null with get,set
        member val ApprovalOn:Boolean = new Boolean() with get,set
        member val Threshold:Decimal = new Decimal() with get,set
        member val Active:Boolean = new Boolean() with get,set
        member val CreatedBy:String = null with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val Members:Int32 = new Int32() with get,set

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

    [<AllowNullLiteral>]
    type DepartmentRequest() = 
        member val DepartmentID:Int32 = new Int32() with get,set
        member val Department:Department = null with get,set

F# DepartmentRequest 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/Department HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	DepartmentID: 0,
	Department: 
	{
		DepartmentID: 0,
		DepartmentUID: 00000000000000000000000000000000,
		Name: String,
		Description: String,
		Code: String,
		Color: String,
		Budget: 0,
		BillingMethod: String,
		CostCenter: String,
		BillingContact: String,
		BillingEmail: String,
		ApprovalOn: False,
		Threshold: 0,
		Active: False,
		CreatedBy: String,
		CreatedAt: 0001-01-01,
		Members: 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
		}
	},
	Department: 
	[
		{
			DepartmentID: 0,
			DepartmentUID: 00000000000000000000000000000000,
			Name: String,
			Description: String,
			Code: String,
			Color: String,
			Budget: 0,
			BillingMethod: String,
			CostCenter: String,
			BillingContact: String,
			BillingEmail: String,
			ApprovalOn: False,
			Threshold: 0,
			Active: False,
			CreatedBy: String,
			CreatedAt: 0001-01-01,
			Members: 0
		}
	]
}