Trendsic Platform Service

<back to all web services

AgreementNeedsSetRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/territory/agreementneeds

export class Territory
{
    public TerritoryID: number;
    public TerritoryUID: string;
    public Name: string;
    public Color: string;
    public ZipCsv: string;
    public CrewID?: number;
    public CrewName: string;
    public Active: boolean;

    public constructor(init?: Partial<Territory>) { (Object as any).assign(this, init); }
}

export class TerritoryPropertyRow
{
    public TerritoryID: number;
    public AgreementID: number;

    public constructor(init?: Partial<TerritoryPropertyRow>) { (Object as any).assign(this, init); }
}

export class CrewEquipmentRow
{
    public CrewID: number;
    public EquipmentID: number;
    public EquipmentName: string;

    public constructor(init?: Partial<CrewEquipmentRow>) { (Object as any).assign(this, init); }
}

export class AgreementNeedRow
{
    public AgreementID: number;
    public EquipmentID: number;
    public EquipmentName: string;

    public constructor(init?: Partial<AgreementNeedRow>) { (Object as any).assign(this, init); }
}

export class TerritoryResponse
{
    public ResponseStatus: ResponseStatus;
    public Territories: Territory[] = [];
    public Properties: TerritoryPropertyRow[] = [];
    public CrewEquipment: CrewEquipmentRow[] = [];
    public AgreementNeeds: AgreementNeedRow[] = [];

    public constructor(init?: Partial<TerritoryResponse>) { (Object as any).assign(this, init); }
}

export class AgreementNeedsSetRequest
{
    public AgreementID: number;
    public EquipmentIDs: number[] = [];

    public constructor(init?: Partial<AgreementNeedsSetRequest>) { (Object as any).assign(this, init); }
}

TypeScript AgreementNeedsSetRequest 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/territory/agreementneeds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AgreementID: 0,
	EquipmentIDs: 
	[
		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
		}
	},
	Territories: 
	[
		{
			TerritoryID: 0,
			TerritoryUID: String,
			Name: String,
			Color: String,
			ZipCsv: String,
			CrewID: 0,
			CrewName: String,
			Active: False
		}
	],
	Properties: 
	[
		{
			TerritoryID: 0,
			AgreementID: 0
		}
	],
	CrewEquipment: 
	[
		{
			CrewID: 0,
			EquipmentID: 0,
			EquipmentName: String
		}
	],
	AgreementNeeds: 
	[
		{
			AgreementID: 0,
			EquipmentID: 0,
			EquipmentName: String
		}
	]
}