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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<StaffMatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Candidates>
    <StaffCandidate>
      <Base>String</Base>
      <BusyJob>String</BusyJob>
      <BusyUntil>String</BusyUntil>
      <Conflict>false</Conflict>
      <ContactID>0</ContactID>
      <DistanceMi>0</DistanceMi>
      <Email>String</Email>
      <Kind>String</Kind>
      <MatchCount>0</MatchCount>
      <Name>String</Name>
      <Phone>String</Phone>
      <Rate>0</Rate>
      <Rating>0</Rating>
      <RatingCount>0</RatingCount>
      <Skills>
        <StaffSkillChip>
          <Matched>false</Matched>
          <Name>String</Name>
        </StaffSkillChip>
      </Skills>
      <Sms>false</Sms>
      <TotalRequired>0</TotalRequired>
    </StaffCandidate>
  </Candidates>
  <Position>
    <ApplicantStrong>0</ApplicantStrong>
    <ApplicantTotal>0</ApplicantTotal>
    <BudgetedHours>0</BudgetedHours>
    <EndDate>String</EndDate>
    <Filled>false</Filled>
    <JobID>0</JobID>
    <JobName>String</JobName>
    <PlaceholderContactID>0</PlaceholderContactID>
    <PositionTag>String</PositionTag>
    <PostingStatus>String</PostingStatus>
    <ProjectID>0</ProjectID>
    <ResponsesActionable>0</ResponsesActionable>
    <Skills xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Skills>
    <StartDate>String</StartDate>
    <TargetRate>0</TargetRate>
    <WindowText>String</WindowText>
  </Position>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</StaffMatchResponse>