Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system
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 RunBillingSystemTenantResult() = 
        member val TenantId:Guid = new Guid() with get,set
        member val BillingRunID:Int32 = new Int32() with get,set
        member val Started:Boolean = new Boolean() with get,set
        member val Message:String = null with get,set

    [<AllowNullLiteral>]
    type RunBillingSystemResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val TenantsSwept:Int32 = new Int32() with get,set
        member val RunsStarted:Int32 = new Int32() with get,set
        member val Reclaimed:Int32 = new Int32() with get,set
        member val Results:ResizeArray<RunBillingSystemTenantResult> = new ResizeArray<RunBillingSystemTenantResult>() with get,set

    [<AllowNullLiteral>]
    type RunBillingSystemRequest() = 
        member val RunType:String = null with get,set
        member val PeriodKey:String = null with get,set
        member val TenantId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val ReclaimStaleMinutes:Int32 = new Int32() with get,set

F# RunBillingSystemRequest 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/billing/run/system HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<RunBillingSystemRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <PeriodKey>String</PeriodKey>
  <ReclaimStaleMinutes>0</ReclaimStaleMinutes>
  <RunType>String</RunType>
  <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
</RunBillingSystemRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<RunBillingSystemResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Reclaimed>0</Reclaimed>
  <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>
  <Results>
    <RunBillingSystemTenantResult>
      <BillingRunID>0</BillingRunID>
      <Message>String</Message>
      <Started>false</Started>
      <TenantId>00000000-0000-0000-0000-000000000000</TenantId>
    </RunBillingSystemTenantResult>
  </Results>
  <RunsStarted>0</RunsStarted>
  <TenantsSwept>0</TenantsSwept>
</RunBillingSystemResponse>