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 .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>