Client_Initiations

<back to all web services

DocumentUploadRequest

Requires Authentication
The following routes are available for this service:
POST/documents
import 'package:servicestack/servicestack.dart';

class DocumentUploadResponse implements IConvertible
{
    String? FileName;
    String? DownloadLink;
    String? ListLink;
    int? DaysToLive;
    String? Message;
    bool? IsSuccess;
    ResponseStatus? ResponseStatus;

    DocumentUploadResponse({this.FileName,this.DownloadLink,this.ListLink,this.DaysToLive,this.Message,this.IsSuccess,this.ResponseStatus});
    DocumentUploadResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        FileName = json['FileName'];
        DownloadLink = json['DownloadLink'];
        ListLink = json['ListLink'];
        DaysToLive = json['DaysToLive'];
        Message = json['Message'];
        IsSuccess = json['IsSuccess'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'FileName': FileName,
        'DownloadLink': DownloadLink,
        'ListLink': ListLink,
        'DaysToLive': DaysToLive,
        'Message': Message,
        'IsSuccess': IsSuccess,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

// @ApiResponse(Description="Returned if a client is not authorized to upload a receipt", StatusCode=401)
// @ApiResponse(Description="Returned if the validation failed for the input expense receipt", StatusCode=412)
// @ApiResponse(Description="Returned if the corresponding expense report was not found", StatusCode=404)
// @ApiResponse(Description="Returned if the call to the expense service failed", StatusCode=400)
class DocumentUploadRequest implements IPost, IConvertible
{
    /**
    * FileName
    */
    // @ApiMember(Description="FileName", IsRequired=true, ParameterType="path")
    String? FileName;

    /**
    * ExternalID
    */
    // @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    String? ExternalId;

    /**
    * RequestStream needs to be base64 file content
    */
    // @ApiMember(Description="RequestStream needs to be base64 file content")
    String? RequestStream;

    DocumentUploadRequest({this.FileName,this.ExternalId,this.RequestStream});
    DocumentUploadRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

    Map<String, dynamic> toJson() => {
        'FileName': FileName,
        'ExternalId': ExternalId,
        'RequestStream': RequestStream
    };

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

TypeContext _ctx = TypeContext(library: 'initiation_test.sirva.com', types: <String, TypeInfo> {
    'DocumentUploadResponse': TypeInfo(TypeOf.Class, create:() => DocumentUploadResponse()),
    'DocumentUploadRequest': TypeInfo(TypeOf.Class, create:() => DocumentUploadRequest()),
});

Dart DocumentUploadRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /documents HTTP/1.1 
Host: initiation-test.sirva.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"FileName":"String","ExternalId":"String","RequestStream":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"FileName":"String","DownloadLink":"String","ListLink":"String","DaysToLive":0,"Message":"String","IsSuccess":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}