Trendsic Platform Service

<back to all web services

EngineExpirySweepRequest

Requires Authentication
The following routes are available for this service:
GET,POST,OPTIONS/v1/engine/sweeps/before-a-date
import 'package:servicestack/servicestack.dart';

class EngineExpirySweepResponse implements IConvertible
{
    bool? Swept;
    String? Why;
    String? LocalDate;
    List<int>? CertMilestones = [];
    List<int>? DocMilestones = [];
    List<int>? ListeningWorkflowIds = [];
    int? Steps;
    int? Claimed;
    int? Written;
    int? Released;
    ResponseStatus? ResponseStatus;

    EngineExpirySweepResponse({this.Swept,this.Why,this.LocalDate,this.CertMilestones,this.DocMilestones,this.ListeningWorkflowIds,this.Steps,this.Claimed,this.Written,this.Released,this.ResponseStatus});
    EngineExpirySweepResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Swept = json['Swept'];
        Why = json['Why'];
        LocalDate = json['LocalDate'];
        CertMilestones = JsonConverters.fromJson(json['CertMilestones'],'List<int>',context!);
        DocMilestones = JsonConverters.fromJson(json['DocMilestones'],'List<int>',context!);
        ListeningWorkflowIds = JsonConverters.fromJson(json['ListeningWorkflowIds'],'List<int>',context!);
        Steps = json['Steps'];
        Claimed = json['Claimed'];
        Written = json['Written'];
        Released = json['Released'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Swept': Swept,
        'Why': Why,
        'LocalDate': LocalDate,
        'CertMilestones': JsonConverters.toJson(CertMilestones,'List<int>',context!),
        'DocMilestones': JsonConverters.toJson(DocMilestones,'List<int>',context!),
        'ListeningWorkflowIds': JsonConverters.toJson(ListeningWorkflowIds,'List<int>',context!),
        'Steps': Steps,
        'Claimed': Claimed,
        'Written': Written,
        'Released': Released,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

class EngineExpirySweepRequest implements IConvertible
{
    int? WorkflowId;

    EngineExpirySweepRequest({this.WorkflowId});
    EngineExpirySweepRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        WorkflowId = json['WorkflowId'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'WorkflowId': WorkflowId
    };

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

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'EngineExpirySweepResponse': TypeInfo(TypeOf.Class, create:() => EngineExpirySweepResponse()),
    'EngineExpirySweepRequest': TypeInfo(TypeOf.Class, create:() => EngineExpirySweepRequest()),
});

Dart EngineExpirySweepRequest 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/engine/sweeps/before-a-date HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<EngineExpirySweepRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <WorkflowId>0</WorkflowId>
</EngineExpirySweepRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<EngineExpirySweepResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CertMilestones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </CertMilestones>
  <Claimed>0</Claimed>
  <DocMilestones xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </DocMilestones>
  <ListeningWorkflowIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>0</d2p1:int>
  </ListeningWorkflowIds>
  <LocalDate>String</LocalDate>
  <Released>0</Released>
  <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>
  <Steps>0</Steps>
  <Swept>false</Swept>
  <Why>String</Why>
  <Written>0</Written>
</EngineExpirySweepResponse>