Trendsic Platform Service

<back to all web services

ShareOtpRequest

The following routes are available for this service:
POST,OPTIONS/share/{Token}/otp
import 'package:servicestack/servicestack.dart';

class ShareLandingResponse implements IConvertible
{
    ResponseStatus? ResponseStatus;
    String? Status;
    bool? RequireOtp;
    String? OtpChannel;
    bool? OtpSent;
    String? DocumentName;
    bool? CanView;
    String? Message;

    ShareLandingResponse({this.ResponseStatus,this.Status,this.RequireOtp,this.OtpChannel,this.OtpSent,this.DocumentName,this.CanView,this.Message});
    ShareLandingResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        Status = json['Status'];
        RequireOtp = json['RequireOtp'];
        OtpChannel = json['OtpChannel'];
        OtpSent = json['OtpSent'];
        DocumentName = json['DocumentName'];
        CanView = json['CanView'];
        Message = json['Message'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!),
        'Status': Status,
        'RequireOtp': RequireOtp,
        'OtpChannel': OtpChannel,
        'OtpSent': OtpSent,
        'DocumentName': DocumentName,
        'CanView': CanView,
        'Message': Message
    };

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

class ShareOtpRequest implements IConvertible
{
    String? Token;

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

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

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

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

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

Dart ShareOtpRequest 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 /share/{Token}/otp HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

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

<ShareLandingResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanView>false</CanView>
  <DocumentName>String</DocumentName>
  <Message>String</Message>
  <OtpChannel>String</OtpChannel>
  <OtpSent>false</OtpSent>
  <RequireOtp>false</RequireOtp>
  <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>
  <Status>String</Status>
</ShareLandingResponse>