POST api/signature/add

Method for adding a signature

Request Information

URI Parameters

None.

Body Parameters

SignaturePostRequest
NameDescriptionTypeAdditional information
Id

Identifier

 string

Required
Type

Type: "CI" = Customer Invoice, "CD" = Customer Delivery Note, "CA" = Customer Advice Note, "CJ" = Customer Job Sheet, "SI" = Supplier Invoice

 string

Required

Max length: 2
Name

Signature name

 string

Required
ImageBase64

Image information in Base64

 string

Required

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "Id": "sample string 1",
  "Type": "sample string 2",
  "Name": "sample string 3",
  "ImageBase64": "sample string 4"
}

application/xml, text/xml

Sample: 
<SignaturePostRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Signature">
  <Id>sample string 1</Id>
  <ImageBase64>sample string 4</ImageBase64>
  <Name>sample string 3</Name>
  <Type>sample string 2</Type>
</SignaturePostRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SignaturePostRequest'.

Response Information

Resource Description

SignaturePostResponse
NameDescriptionTypeAdditional information
Errors

List of errors when adding article

 Collection of PostSignatureError

None.
Success

Returns true if article is added

 boolean

None.

Response Formats

application/json, text/json

Sample: 
{
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ],
  "Success": true
}

application/xml, text/xml

Sample: 
<SignaturePostResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Signature">
  <Errors>
    <PostSignatureError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostSignatureError>
    <PostSignatureError>
      <ErrorCode>InternalServerError</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </PostSignatureError>
  </Errors>
  <Success>true</Success>
</SignaturePostResponse>