Trendsic Platform Service

<back to all web services

StaffMatchRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/staff/match
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StaffSkillChip:
    name: Optional[str] = None
    matched: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StaffCandidate:
    contact_i_d: int = 0
    name: Optional[str] = None
    kind: Optional[str] = None
    rate: Decimal = decimal.Decimal(0)
    rating: Decimal = decimal.Decimal(0)
    rating_count: int = 0
    base: Optional[str] = None
    distance_mi: int = 0
    match_count: int = 0
    total_required: int = 0
    skills: List[StaffSkillChip] = field(default_factory=list)
    conflict: bool = False
    busy_until: Optional[str] = None
    busy_job: Optional[str] = None
    phone: Optional[str] = None
    email: Optional[str] = None
    sms: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StaffPosition:
    placeholder_contact_i_d: int = 0
    job_i_d: int = 0
    project_i_d: int = 0
    job_name: Optional[str] = None
    position_tag: Optional[str] = None
    skills: List[str] = field(default_factory=list)
    budgeted_hours: float = 0.0
    target_rate: Decimal = decimal.Decimal(0)
    start_date: Optional[str] = None
    end_date: Optional[str] = None
    window_text: Optional[str] = None
    responses_actionable: int = 0
    posting_status: Optional[str] = None
    applicant_total: int = 0
    applicant_strong: int = 0
    filled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StaffMatchResponse:
    response_status: Optional[ResponseStatus] = None
    candidates: List[StaffCandidate] = field(default_factory=list)
    position: Optional[StaffPosition] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class StaffMatchRequest:
    placeholder_contact_i_d: int = 0
    job_i_d: int = 0

Python 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
	}
}