Trendsic Platform Service

<back to all web services

RunBillingSystemRequest

The following routes are available for this service:
POST/v1/billing/run/system
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class RunBillingSystemRequest
    {
        public String RunType = null;
        public String PeriodKey = null;
        public UUID TenantId = null;
        public Integer ReclaimStaleMinutes = null;
        
        public String getRunType() { return RunType; }
        public RunBillingSystemRequest setRunType(String value) { this.RunType = value; return this; }
        public String getPeriodKey() { return PeriodKey; }
        public RunBillingSystemRequest setPeriodKey(String value) { this.PeriodKey = value; return this; }
        public UUID getTenantId() { return TenantId; }
        public RunBillingSystemRequest setTenantId(UUID value) { this.TenantId = value; return this; }
        public Integer getReclaimStaleMinutes() { return ReclaimStaleMinutes; }
        public RunBillingSystemRequest setReclaimStaleMinutes(Integer value) { this.ReclaimStaleMinutes = value; return this; }
    }

    public static class RunBillingSystemResponse
    {
        public ResponseStatus ResponseStatus = null;
        public Integer TenantsSwept = null;
        public Integer RunsStarted = null;
        public Integer Reclaimed = null;
        public ArrayList<RunBillingSystemTenantResult> Results = new ArrayList<RunBillingSystemTenantResult>();
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public RunBillingSystemResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public Integer getTenantsSwept() { return TenantsSwept; }
        public RunBillingSystemResponse setTenantsSwept(Integer value) { this.TenantsSwept = value; return this; }
        public Integer getRunsStarted() { return RunsStarted; }
        public RunBillingSystemResponse setRunsStarted(Integer value) { this.RunsStarted = value; return this; }
        public Integer getReclaimed() { return Reclaimed; }
        public RunBillingSystemResponse setReclaimed(Integer value) { this.Reclaimed = value; return this; }
        public ArrayList<RunBillingSystemTenantResult> getResults() { return Results; }
        public RunBillingSystemResponse setResults(ArrayList<RunBillingSystemTenantResult> value) { this.Results = value; return this; }
    }

    public static class RunBillingSystemTenantResult
    {
        public UUID TenantId = null;
        public Integer BillingRunID = null;
        public Boolean Started = null;
        public String Message = null;
        
        public UUID getTenantId() { return TenantId; }
        public RunBillingSystemTenantResult setTenantId(UUID value) { this.TenantId = value; return this; }
        public Integer getBillingRunID() { return BillingRunID; }
        public RunBillingSystemTenantResult setBillingRunID(Integer value) { this.BillingRunID = value; return this; }
        public Boolean isStarted() { return Started; }
        public RunBillingSystemTenantResult setStarted(Boolean value) { this.Started = value; return this; }
        public String getMessage() { return Message; }
        public RunBillingSystemTenantResult setMessage(String value) { this.Message = value; return this; }
    }

}

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