Trendsic Platform Service

<back to all web services

ClientWorkerRestrictionByWorkerRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/restriction/byworker/{WorkerContactID}
"use strict";
export class ClientWorkerRestriction {
    /** @param {{ClientWorkerRestrictionID?:number,BranchId?:string,ClientContactID?:number,WorkerContactID?:number,RestrictionLevel?:string,Reason?:string,SourceRatingID?:number,CreatedBy?:string,CreatedAt?:string,UpdatedAt?:string,ClientName?:string,WorkerName?:string,LevelLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ClientWorkerRestrictionID;
    /** @type {?string} */
    BranchId;
    /** @type {number} */
    ClientContactID;
    /** @type {number} */
    WorkerContactID;
    /** @type {string} */
    RestrictionLevel;
    /** @type {string} */
    Reason;
    /** @type {?number} */
    SourceRatingID;
    /** @type {string} */
    CreatedBy;
    /** @type {string} */
    CreatedAt;
    /** @type {?string} */
    UpdatedAt;
    /** @type {string} */
    ClientName;
    /** @type {string} */
    WorkerName;
    /** @type {string} */
    LevelLabel;
}
export class RestrictionParty {
    /** @param {{ContactId?:number,Name?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    ContactId;
    /** @type {string} */
    Name;
}
export class ClientWorkerRestrictionsResponse {
    /** @param {{Restrictions?:ClientWorkerRestriction[],Clients?:RestrictionParty[],Workers?:RestrictionParty[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ClientWorkerRestriction[]} */
    Restrictions = [];
    /** @type {RestrictionParty[]} */
    Clients = [];
    /** @type {RestrictionParty[]} */
    Workers = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class ClientWorkerRestrictionByWorkerRequest {
    /** @param {{WorkerContactID?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkerContactID;
}

JavaScript ClientWorkerRestrictionByWorkerRequest 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/coverage/restriction/byworker/{WorkerContactID} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<ClientWorkerRestrictionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Clients>
    <RestrictionParty>
      <ContactId>0</ContactId>
      <Name>String</Name>
    </RestrictionParty>
  </Clients>
  <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>
  <Restrictions>
    <ClientWorkerRestriction>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <ClientContactID>0</ClientContactID>
      <ClientName>String</ClientName>
      <ClientWorkerRestrictionID>0</ClientWorkerRestrictionID>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CreatedBy>String</CreatedBy>
      <LevelLabel>String</LevelLabel>
      <Reason>String</Reason>
      <RestrictionLevel>String</RestrictionLevel>
      <SourceRatingID>0</SourceRatingID>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <WorkerContactID>0</WorkerContactID>
      <WorkerName>String</WorkerName>
    </ClientWorkerRestriction>
  </Restrictions>
  <Workers>
    <RestrictionParty>
      <ContactId>0</ContactId>
      <Name>String</Name>
    </RestrictionParty>
  </Workers>
</ClientWorkerRestrictionsResponse>