Trendsic Platform Service

<back to all web services

PayrollBatchRequest

Requires Authentication
Requires any of the roles:Agent, Administrator
The following routes are available for this service:
GET,OPTIONS/v1/PayrollBatch
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CommissionBatch() = 
        member val CommissionBatchId:Int32 = new Int32() with get,set
        member val DateCreated:DateTime = new DateTime() with get,set
        member val CreatedBy:String = null with get,set
        member val CommissionTitle:String = null with get,set
        member val CommissionStartDate:DateTime = new DateTime() with get,set
        member val CommissionEndDate:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type PayrollBatchResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Payroll:ResizeArray<CommissionBatch> = new ResizeArray<CommissionBatch>() with get,set

    [<AllowNullLiteral>]
    type PayrollBatchRequest() = 
        class end

F# PayrollBatchRequest 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/PayrollBatch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PayrollBatchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Payroll>
    <CommissionBatch>
      <CommissionBatchId>0</CommissionBatchId>
      <CommissionEndDate>0001-01-01T00:00:00</CommissionEndDate>
      <CommissionStartDate>0001-01-01T00:00:00</CommissionStartDate>
      <CommissionTitle>String</CommissionTitle>
      <CreatedBy>String</CreatedBy>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
    </CommissionBatch>
  </Payroll>
  <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>
</PayrollBatchResponse>