OrderAttachments

Use these methods to download the order attachments (= files) that the signer may have uploaded during the sign process.

DO's:

• Always start with a call to the List method.
• Always use the ID's from the result of the List method to fetch the attachments.

DONT's:

• Don't limit yourself to X attachments pr. order - there may or may not be more attachments.
• Don't treat the AttachmentId as a integer - it may change in the future so always treat it as a string.

The following model is used in the GetAttachment call:

OrderAttachmentsModel

Name	Type	Description	Optional
Id	Int	The Id of this attachment - use in GetAttachment call.
FieldId	Int	User supplied field Id.
FieldName	String	User supplied field Name.
OrderId	Guid	Order ID.
AttachmentId	String	Attachment ID - gotten from a previous call to OrderAttachments/List.

The following models are used in the response:

OrderAttachmentsResponseModel

Name	Type	Description	Optional
Name	String	(File-)Name of order attachment.
Data	String	Base64 encoded order attachment content.
FieldId	Int	User supplied field Id (playback).
FieldName	String	User supplied field name (playback).

OrderAttachmentsListResponseModel

Name	Type	Description	Optional
Id	String	The Id of this attachment - use in GetAttachment call.
FieldId	Int	User supplied field Id.
FieldName	String	User supplied field Name.

List

Description

Get a list of order attachments for this order.

Synopsis

GET api.esignatur.dk/OrderAttachments/List/{id}

JSON Output

[
  {
    "Id": 2017,
    "FieldId": 1,
    "FieldName": "SomeField_1",
    "OrderId": "00000000-0000-0000-0000-000000000000"
  },
  {
    "Id": 2018,
    "FieldId": 20,
    "FieldName": "SomeField_20",
    "OrderId": "00000000-0000-0000-0000-000000000000"
  },
  {
    "Id": 2019,
    "FieldId": 300,
    "FieldName": "SomeField_300",
    "OrderId": "00000000-0000-0000-0000-000000000000"
  }
]

GetAttachment

Description

Get a single order attachment.

Synopsis

POST api.esignatur.dk/OrderAttachments/GetAttachment

JSON Input

{
  "Id": 0,
  "FieldId": 0,
  "OrderId": "5026aa48-30c4-477c-8a35-edf3c0df169c",
  "AttachmentId": "2017"
}

JSON Output

{
  "Name": "advice.txt",
  "Data": "RG9uJ3QgZ2V0IGxvc3Qh",
  "FieldId": 0
}