PullDocumentsByKey
Pulls deal documents by API DealKey.
Request Information
Parameters
Collection of string
Sample Request
<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<string>sample string 1</string>
<string>sample string 2</string>
</ArrayOfstring>
Response Information
Resource Description
Collection of
Document
Name | Description | Type | Additional information |
DocumentKey |
|
string
|
Required
|
DocumentName |
|
string
|
|
DocumentOrderSeq |
|
integer
|
|
DealKey |
|
string
|
|
UnSignedDocument |
|
string
|
|
SignedDocument |
|
string
|
|
ExternalDocumentKey |
|
string
|
|
Placement |
|
StorePlacement
|
|
Sample Response
<ArrayOfDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DealerBuilt.BaseApi">
<Document>
<Placement>
<GroupId>8</GroupId>
<GroupName>sample string 9</GroupName>
<EnvironmentId>7</EnvironmentId>
<EnvironmentType>Undefined</EnvironmentType>
<DealerId>6</DealerId>
<SourceId>5</SourceId>
<CompanyId>3</CompanyId>
<CompanyName>sample string 4</CompanyName>
<StoreId>1</StoreId>
<StoreName>sample string 2</StoreName>
</Placement>
<DealKey>sample string 4</DealKey>
<DocumentKey>sample string 1</DocumentKey>
<DocumentName>sample string 2</DocumentName>
<DocumentOrderSeq>3</DocumentOrderSeq>
<ExternalDocumentKey>sample string 7</ExternalDocumentKey>
<SignedDocument>sample string 6</SignedDocument>
<UnSignedDocument>sample string 5</UnSignedDocument>
</Document>
<Document>
<Placement>
<GroupId>8</GroupId>
<GroupName>sample string 9</GroupName>
<EnvironmentId>7</EnvironmentId>
<EnvironmentType>Undefined</EnvironmentType>
<DealerId>6</DealerId>
<SourceId>5</SourceId>
<CompanyId>3</CompanyId>
<CompanyName>sample string 4</CompanyName>
<StoreId>1</StoreId>
<StoreName>sample string 2</StoreName>
</Placement>
<DealKey>sample string 4</DealKey>
<DocumentKey>sample string 1</DocumentKey>
<DocumentName>sample string 2</DocumentName>
<DocumentOrderSeq>3</DocumentOrderSeq>
<ExternalDocumentKey>sample string 7</ExternalDocumentKey>
<SignedDocument>sample string 6</SignedDocument>
<UnSignedDocument>sample string 5</UnSignedDocument>
</Document>
</ArrayOfDocument>