GET api/envelope/{EnvelopeID}/additional?SourceReference={SourceReference}&SourceSystem={SourceSystem}
Used to get additional details of envelope
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
EnvelopeID |
This is envelope's Id |
string |
Required |
SourceReference |
This is envelope's source reference |
string |
Default value is |
SourceSystem |
This is envelope's source system |
string |
Default value is |
Body Parameters
None.
Response Information
Resource Description
EnvelopeAdditionalDTOName | Description | Type | Additional information |
---|---|---|---|
SourceReference |
This is envelope's Source Reference |
string |
None. |
EntityId |
This is envelope reveiver's id |
string |
None. |
EntityCode |
This is envelope reveiver's code |
string |
None. |
EntityType |
This is envelope reveiver's type |
string |
None. |
EntityName |
This is envelope reveiver's name |
string |
None. |
EntityJobTitle |
This is envelope reveiver's JobTitle |
string |
None. |
SenderName |
This is envelope sender's Name |
string |
None. |
SenderEmail |
This is envelope sender's Email |
string |
None. |
SenderPhone |
This is envelope sender's Phone |
string |
None. |
SenderSignature |
This is envelope sender's signature |
string |
None. |
Response Formats
application/json, text/json
Sample:
{ "SourceReference": "sample string 1", "EntityId": "sample string 2", "EntityCode": "sample string 3", "EntityType": "sample string 4", "EntityName": "sample string 5", "EntityJobTitle": "sample string 6", "SenderName": "sample string 7", "SenderEmail": "sample string 8", "SenderPhone": "sample string 9", "SenderSignature": "sample string 10" }
text/xml
Sample:
<EnvelopeAdditionalDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"> <EntityCode>sample string 3</EntityCode> <EntityId>sample string 2</EntityId> <EntityJobTitle>sample string 6</EntityJobTitle> <EntityName>sample string 5</EntityName> <EntityType>sample string 4</EntityType> <SenderEmail>sample string 8</SenderEmail> <SenderName>sample string 7</SenderName> <SenderPhone>sample string 9</SenderPhone> <SenderSignature>sample string 10</SenderSignature> <SourceReference>sample string 1</SourceReference> </EnvelopeAdditionalDTO>
multipart/form-data
Sample:
<EnvelopeAdditionalDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RandstadWebAPI.Models.DTO"><EntityCode>sample string 3</EntityCode><EntityId>sample string 2</EntityId><EntityJobTitle>sample string 6</EntityJobTitle><EntityName>sample string 5</EntityName><EntityType>sample string 4</EntityType><SenderEmail>sample string 8</SenderEmail><SenderName>sample string 7</SenderName><SenderPhone>sample string 9</SenderPhone><SenderSignature>sample string 10</SenderSignature><SourceReference>sample string 1</SourceReference></EnvelopeAdditionalDTO>