Skip to content

DocumentAttachmentsApi.md

Latest commit

 

History

History
208 lines (159 loc) · 6.46 KB

DocumentAttachmentsApi.md

File metadata and controls

208 lines (159 loc) · 6.46 KB

SignRequest.Api.DocumentAttachmentsApi

All URIs are relative to https://signrequest.com/api/v1

Method HTTP request Description
DocumentAttachmentsCreate POST /document-attachments/ Create a Document Attachment
DocumentAttachmentsList GET /document-attachments/ Retrieve a list of Document Attachments
DocumentAttachmentsRead GET /document-attachments/{uuid}/ Retrieve a Document Attachment

DocumentAttachmentsCreate

DocumentAttachment DocumentAttachmentsCreate (DocumentAttachment data)

Create a Document Attachment

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class DocumentAttachmentsCreateExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new DocumentAttachmentsApi();
            var data = new DocumentAttachment(); // DocumentAttachment | 

            try
            {
                // Create a Document Attachment
                DocumentAttachment result = apiInstance.DocumentAttachmentsCreate(data);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAttachmentsApi.DocumentAttachmentsCreate: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
data DocumentAttachment

Return type

DocumentAttachment

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DocumentAttachmentsList

InlineResponse2001 DocumentAttachmentsList (string documentUuid = null, string documentExternalId = null, string created = null, int? page = null, int? limit = null)

Retrieve a list of Document Attachments

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class DocumentAttachmentsListExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new DocumentAttachmentsApi();
            var documentUuid = documentUuid_example;  // string |  (optional) 
            var documentExternalId = documentExternalId_example;  // string |  (optional) 
            var created = created_example;  // string |  (optional) 
            var page = 56;  // int? | A page number within the paginated result set. (optional) 
            var limit = 56;  // int? | Number of results to return per page. (optional) 

            try
            {
                // Retrieve a list of Document Attachments
                InlineResponse2001 result = apiInstance.DocumentAttachmentsList(documentUuid, documentExternalId, created, page, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAttachmentsApi.DocumentAttachmentsList: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
documentUuid string [optional]
documentExternalId string [optional]
created string [optional]
page int? A page number within the paginated result set. [optional]
limit int? Number of results to return per page. [optional]

Return type

InlineResponse2001

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DocumentAttachmentsRead

DocumentAttachment DocumentAttachmentsRead (string uuid)

Retrieve a Document Attachment

Example

using System;
using System.Diagnostics;
using SignRequest.Api;
using SignRequest.Client;
using SignRequest.Model;

namespace Example
{
    public class DocumentAttachmentsReadExample
    {
        public void main()
        {
            // Configure API key authorization: Token
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            Configuration.Default.AddApiKeyPrefix("Authorization", "Token");

            var apiInstance = new DocumentAttachmentsApi();
            var uuid = uuid_example;  // string | 

            try
            {
                // Retrieve a Document Attachment
                DocumentAttachment result = apiInstance.DocumentAttachmentsRead(uuid);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling DocumentAttachmentsApi.DocumentAttachmentsRead: " + e.Message );
            }
        }
    }
}

Parameters

Name Type Description Notes
uuid string

Return type

DocumentAttachment

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]