Trendsic Platform Service

<back to all web services

ClientWorkerRestrictionSetRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/restriction
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class ClientWorkerRestriction
            Public Overridable Property ClientWorkerRestrictionID As Integer
            Public Overridable Property BranchId As Guid?
            Public Overridable Property ClientContactID As Integer
            Public Overridable Property WorkerContactID As Integer
            Public Overridable Property RestrictionLevel As String
            Public Overridable Property Reason As String
            Public Overridable Property SourceRatingID As Integer?
            Public Overridable Property CreatedBy As String
            Public Overridable Property CreatedAt As Date
            Public Overridable Property UpdatedAt As Date?
            Public Overridable Property ClientName As String
            Public Overridable Property WorkerName As String
            Public Overridable Property LevelLabel As String
        End Class

        Public Partial Class ClientWorkerRestrictionSetRequest
            Public Overridable Property BranchId As Guid?
            Public Overridable Property ClientContactID As Integer
            Public Overridable Property WorkerContactID As Integer
            Public Overridable Property RestrictionLevel As String
            Public Overridable Property Reason As String
            Public Overridable Property SourceRatingID As Integer?
        End Class

        Public Partial Class ClientWorkerRestrictionsResponse
            Public Overridable Property Restrictions As List(Of ClientWorkerRestriction) = New List(Of ClientWorkerRestriction)
            Public Overridable Property Clients As List(Of RestrictionParty) = New List(Of RestrictionParty)
            Public Overridable Property Workers As List(Of RestrictionParty) = New List(Of RestrictionParty)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class RestrictionParty
            Public Overridable Property ContactId As Integer
            Public Overridable Property Name As String
        End Class
    End Namespace
End Namespace

VB.NET ClientWorkerRestrictionSetRequest 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.

POST /v1/coverage/restriction HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<ClientWorkerRestrictionSetRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <ClientContactID>0</ClientContactID>
  <Reason>String</Reason>
  <RestrictionLevel>String</RestrictionLevel>
  <SourceRatingID>0</SourceRatingID>
  <WorkerContactID>0</WorkerContactID>
</ClientWorkerRestrictionSetRequest>
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>