Client_Initiations

<back to all web services

DocumentUploadRequest

Requires Authentication
The following routes are available for this service:
POST/documents

export class DocumentUploadResponse
{
    public FileName: string;
    public DownloadLink: string;
    public ListLink: string;
    public DaysToLive: number;
    public Message: string;
    public IsSuccess: boolean;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<DocumentUploadResponse>) { (Object as any).assign(this, init); }
}

// @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)
export class DocumentUploadRequest implements IPost
{
    /** @description FileName */
    // @ApiMember(Description="FileName", IsRequired=true, ParameterType="path")
    public FileName: string;

    /** @description ExternalID */
    // @ApiMember(Description="ExternalID", ExcludeInSchema=true, IsRequired=true, ParameterType="path")
    public ExternalId: string;

    /** @description RequestStream needs to be base64 file content */
    // @ApiMember(Description="RequestStream needs to be base64 file content")
    public RequestStream: string;

    public constructor(init?: Partial<DocumentUploadRequest>) { (Object as any).assign(this, init); }
}

TypeScript DocumentUploadRequest DTOs

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

HTTP + CSV

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-pen.sirva.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"FileName":"String","ExternalId":"String","RequestStream":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}