GET Draft/AdditionalDetails/{id}
Gets a collection of AdditionalDetail objects associated with the specified notice. The notice is identified by its GUID.
Requires Authorization
The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
The identity of the notice. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
A collection of AdditionalDetail objects; otherwise a collection of errors with HTTP status 400.
Collection of AdditionalDetailTo access an attachment or supplier attachment perform the following steps:
- Extract the Id from the response
- Extract the DataType from the response
- Compose the URL comprising of the following
- https://www.contractsfinder.service.gov.uk/Notice
- <DataType>/
- <Id>
| Name | Description | Type | Additional information |
|---|---|---|---|
| Id |
Gets or sets the Id (Assigned by the system at creation, should only be supplied for subsequent updates and actions). |
globally unique identifier |
None. |
| NoticeId |
The GUID identifying the notice that this additional detail relates to. |
globally unique identifier |
None. |
| Description |
A description of this additional detail. |
string |
Must be 1000 characters or fewer |
| DataType |
The type of this additional detail. |
AdditionalDetailType |
None. |
| DocumentType |
The document type of this additional detail. |
OCDSDocumentTypeCode |
None. |
| TextData |
The additional text (only populated when the DataType specifies AdditionalText) |
string |
None. |
| Link |
A URL link to relevant information (only populated when the DataType specifies a Link) |
string |
None. |
| MimeType |
The MIME type of an attached file (only populated when the DataType specifies a Attachment or SupplierAttachment) |
string |
Must be a valid MimeType |
| Filename |
The filename of an attached file (only populated when the DataType specifies a Attachment or SupplierAttachment) |
string |
Must be a valid Extension |
| FileContent |
The raw content of an attached file (only populated when the DataType specifies a Attachment or SupplierAttachment) |
Collection of byte |
FileContent must be smaller than 100MB before encoding. |
| AwardGuid |
Gets or sets the id of the award this item is associated with, if relevant |
globally unique identifier |
None. |
Response Formats
application/json, text/json
[
{
"id": "e18c23be-0293-4f76-817c-1dcda84ebe42",
"noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0",
"description": "Organisation link",
"dataType": "Link",
"textData": null,
"link": "http://www.org.co.uk/",
"mimeType": null,
"filename": null,
"fileContent": null,
"awardGuid": null
},
{
"id": "c3c27b8a-f404-45de-bf62-48c5cdc5e0ec",
"noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0",
"description": "Document attachment",
"dataType": "Attachment",
"textData": null,
"link": null,
"mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
"filename": "Proposal.docx",
"fileContent": null,
"awardGuid": null
},
{
"id": "c3c27b8a-f404-45de-bf62-48c5cdc5e0ec",
"noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0",
"description": null,
"dataType": "Attachment",
"textData": null,
"link": null,
"mimeType": null,
"filename": null,
"fileContent": null,
"awardGuid": null
}
]
application/xml, text/xml
<ArrayOfAdditionalDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
<AdditionalDetail>
<AwardGuid i:nil="true" />
<DataType>Link</DataType>
<Description>Organisation link</Description>
<FileContent i:nil="true" />
<Filename i:nil="true" />
<Id>e18c23be-0293-4f76-817c-1dcda84ebe42</Id>
<Link>http://www.org.co.uk/</Link>
<MimeType i:nil="true" />
<NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId>
<TextData i:nil="true" />
</AdditionalDetail>
<AdditionalDetail>
<AwardGuid i:nil="true" />
<DataType>Attachment</DataType>
<Description>Document attachment</Description>
<FileContent i:nil="true" />
<Filename>Proposal.docx</Filename>
<Id>c3c27b8a-f404-45de-bf62-48c5cdc5e0ec</Id>
<Link i:nil="true" />
<MimeType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</MimeType>
<NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId>
<TextData i:nil="true" />
</AdditionalDetail>
<AdditionalDetail>
<AwardGuid i:nil="true" />
<DataType>Attachment</DataType>
<Description i:nil="true" />
<FileContent i:nil="true" />
<Filename i:nil="true" />
<Id>c3c27b8a-f404-45de-bf62-48c5cdc5e0ec</Id>
<Link i:nil="true" />
<MimeType i:nil="true" />
<NoticeId>d31c1dfb-462c-42f6-ab22-6860cc3a65b0</NoticeId>
<TextData i:nil="true" />
</AdditionalDetail>
</ArrayOfAdditionalDetail>