PUT api/envelope/{EnvelopeID}/notify

Used to notify the envelope status update

Request Information

URI Parameters

Name	Description	Type	Additional information
EnvelopeID	This is envelope's Id	string	Required

Body Parameters

This is envelope's Notification data

EnvelopeNotificationDTO

Name	Description	Type	Additional information
SourceReference	This is envelope's Source Reference	string	None.
SourceSystem	This is envelope's Source system	string	None.
EnvelopeId	This is formly envelope ID	string	None.
EnvelopeStatus	This is Envelope's Status	string	None.
TemplateId	This is formly template ID	string	None.
TemplateCode	This is formly template Code	string	None.
EnvelopeTemplateStatus	This is EnvelopeTemplate's Status	string	None.

Request Formats

application/json, text/json

Sample:

{
  "SourceReference": "sample string 1",
  "SourceSystem": "sample string 2",
  "EnvelopeId": "sample string 3",
  "EnvelopeStatus": "sample string 4",
  "TemplateId": "sample string 5",
  "TemplateCode": "sample string 6",
  "EnvelopeTemplateStatus": "sample string 7"
}

text/xml

Sample:

<EnvelopeNotificationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO">
  <EnvelopeId>sample string 3</EnvelopeId>
  <EnvelopeStatus>sample string 4</EnvelopeStatus>
  <EnvelopeTemplateStatus>sample string 7</EnvelopeTemplateStatus>
  <SourceReference>sample string 1</SourceReference>
  <SourceSystem>sample string 2</SourceSystem>
  <TemplateCode>sample string 6</TemplateCode>
  <TemplateId>sample string 5</TemplateId>
</EnvelopeNotificationDTO>

multipart/form-data

Sample:

<EnvelopeNotificationDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><EnvelopeId>sample string 3</EnvelopeId><EnvelopeStatus>sample string 4</EnvelopeStatus><EnvelopeTemplateStatus>sample string 7</EnvelopeTemplateStatus><SourceReference>sample string 1</SourceReference><SourceSystem>sample string 2</SourceSystem><TemplateCode>sample string 6</TemplateCode><TemplateId>sample string 5</TemplateId></EnvelopeNotificationDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

result

boolean

Response Formats

application/json, text/json

Sample:

true

text/xml, multipart/form-data

Sample:

<boolean xmlns="http://schemas.microsoft.com/2003/10/Serialization/">true</boolean>