Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

class RunBillingSystemTenantResult implements IConvertible
{
    String? TenantId;
    int? BillingRunID;
    bool? Started;
    String? Message;

    RunBillingSystemTenantResult({this.TenantId,this.BillingRunID,this.Started,this.Message});
    RunBillingSystemTenantResult.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        TenantId = json['TenantId'];
        BillingRunID = json['BillingRunID'];
        Started = json['Started'];
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'TenantId': TenantId,
        'BillingRunID': BillingRunID,
        'Started': Started,
        'Message': Message
    };

    getTypeName() => "RunBillingSystemTenantResult";
    TypeContext? context = _ctx;
}

class RunBillingSystemResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    int? TenantsSwept;
    int? RunsStarted;
    int? Reclaimed;
    List<RunBillingSystemTenantResult>? Results = [];

    RunBillingSystemResponse({this.ResponseStatus,this.TenantsSwept,this.RunsStarted,this.Reclaimed,this.Results});
    RunBillingSystemResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        TenantsSwept = json['TenantsSwept'];
        RunsStarted = json['RunsStarted'];
        Reclaimed = json['Reclaimed'];
        Results = JsonConverters.fromJson(json['Results'],'List<RunBillingSystemTenantResult>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'TenantsSwept': TenantsSwept,
        'RunsStarted': RunsStarted,
        'Reclaimed': Reclaimed,
        'Results': JsonConverters.toJson(Results,'List<RunBillingSystemTenantResult>',context!)
    };

    getTypeName() => "RunBillingSystemResponse";
    TypeContext? context = _ctx;
}

class RunBillingSystemRequest implements IConvertible
{
    String? RunType;
    String? PeriodKey;
    String? TenantId;
    int? ReclaimStaleMinutes;

    RunBillingSystemRequest({this.RunType,this.PeriodKey,this.TenantId,this.ReclaimStaleMinutes});
    RunBillingSystemRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        RunType = json['RunType'];
        PeriodKey = json['PeriodKey'];
        TenantId = json['TenantId'];
        ReclaimStaleMinutes = json['ReclaimStaleMinutes'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'RunType': RunType,
        'PeriodKey': PeriodKey,
        'TenantId': TenantId,
        'ReclaimStaleMinutes': ReclaimStaleMinutes
    };

    getTypeName() => "RunBillingSystemRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'RunBillingSystemTenantResult': TypeInfo(TypeOf.Class, create:() => RunBillingSystemTenantResult()),
    'RunBillingSystemResponse': TypeInfo(TypeOf.Class, create:() => RunBillingSystemResponse()),
    'List<RunBillingSystemTenantResult>': TypeInfo(TypeOf.Class, create:() => <RunBillingSystemTenantResult>[]),
    'RunBillingSystemRequest': TypeInfo(TypeOf.Class, create:() => RunBillingSystemRequest()),
});

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