Trendsic Platform Service

<back to all web services

StaffMatchRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/staff/match
"use strict";
export class StaffSkillChip {
    /** @param {{Name?:string,Matched?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {boolean} */
    Matched;
}
export class StaffCandidate {
    /** @param {{ContactID?:number,Name?:string,Kind?:string,Rate?:number,Rating?:number,RatingCount?:number,Base?:string,DistanceMi?:number,MatchCount?:number,TotalRequired?:number,Skills?:StaffSkillChip[],Conflict?:boolean,BusyUntil?:string,BusyJob?:string,Phone?:string,Email?:string,Sms?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactID;
    /** @type {string} */
    Name;
    /** @type {string} */
    Kind;
    /** @type {number} */
    Rate;
    /** @type {number} */
    Rating;
    /** @type {number} */
    RatingCount;
    /** @type {string} */
    Base;
    /** @type {number} */
    DistanceMi;
    /** @type {number} */
    MatchCount;
    /** @type {number} */
    TotalRequired;
    /** @type {StaffSkillChip[]} */
    Skills = [];
    /** @type {boolean} */
    Conflict;
    /** @type {string} */
    BusyUntil;
    /** @type {string} */
    BusyJob;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
    /** @type {boolean} */
    Sms;
}
export class StaffPosition {
    /** @param {{PlaceholderContactID?:number,JobID?:number,ProjectID?:number,JobName?:string,PositionTag?:string,Skills?:string[],BudgetedHours?:number,TargetRate?:number,StartDate?:string,EndDate?:string,WindowText?:string,ResponsesActionable?:number,PostingStatus?:string,ApplicantTotal?:number,ApplicantStrong?:number,Filled?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PlaceholderContactID;
    /** @type {number} */
    JobID;
    /** @type {number} */
    ProjectID;
    /** @type {string} */
    JobName;
    /** @type {string} */
    PositionTag;
    /** @type {string[]} */
    Skills = [];
    /** @type {number} */
    BudgetedHours;
    /** @type {number} */
    TargetRate;
    /** @type {string} */
    StartDate;
    /** @type {string} */
    EndDate;
    /** @type {string} */
    WindowText;
    /** @type {number} */
    ResponsesActionable;
    /** @type {string} */
    PostingStatus;
    /** @type {number} */
    ApplicantTotal;
    /** @type {number} */
    ApplicantStrong;
    /** @type {boolean} */
    Filled;
}
export class StaffMatchResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Candidates?:StaffCandidate[],Position?:StaffPosition}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {StaffCandidate[]} */
    Candidates = [];
    /** @type {StaffPosition} */
    Position;
}
export class StaffMatchRequest {
    /** @param {{PlaceholderContactID?:number,JobID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    PlaceholderContactID;
    /** @type {number} */
    JobID;
}

JavaScript StaffMatchRequest 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/staff/match 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
		}
	},
	Candidates: 
	[
		{
			ContactID: 0,
			Name: String,
			Kind: String,
			Rate: 0,
			Rating: 0,
			RatingCount: 0,
			Base: String,
			DistanceMi: 0,
			MatchCount: 0,
			TotalRequired: 0,
			Skills: 
			[
				{
					Name: String,
					Matched: False
				}
			],
			Conflict: False,
			BusyUntil: String,
			BusyJob: String,
			Phone: String,
			Email: String,
			Sms: False
		}
	],
	Position: 
	{
		PlaceholderContactID: 0,
		JobID: 0,
		ProjectID: 0,
		JobName: String,
		PositionTag: String,
		Skills: 
		[
			String
		],
		BudgetedHours: 0,
		TargetRate: 0,
		StartDate: String,
		EndDate: String,
		WindowText: String,
		ResponsesActionable: 0,
		PostingStatus: String,
		ApplicantTotal: 0,
		ApplicantStrong: 0,
		Filled: False
	}
}