GET Published/AdditionalDetails/{id}
Gets a single additional detail object by its unique identifier. The identifier is a GUID. The returned additional detail is contained in a AdditionalDetail object.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
id |
A GUID uniquely identifying the additional detail object being requested. |
globally unique identifier |
Required |
Body Parameters
None.
Response Information
Resource Description
A AdditionalDetail if it exists; otherwise a HTTP status of 404.
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
HTTP response status code: 200
application/json, text/json
{ "id": "c3c27b8a-f404-45de-bf62-48c5cdc5e0ec", "description": "Document attachment", "dataType": "Attachment", "textData": null, "link": null, "filename": "Proposal.docx", "fileContent": null, "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document", "awardGuid": null }
application/xml, text/xml
<AdditionalDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities"> <DataType>Attachment</DataType> <AwardGuid i:nil="true" /> <FileContent i:nil="true" /> <Description>Document attachment</Description> <Filename>Proposal.docx</Filename> <Id>c3c27b8a-f404-45de-bf62-48c5cdc5e0ec</Id> <Link i:nil="true" /> <MimeType>application/vnd.openxmlformats-officedocument.wordprocessingml.document</MimeType> <TextData i:nil="true" /> </AdditionalDetail>
HTTP response status code: 403
When the user has submitted too many requests, no further requests should be made until after 5 minutes
text/plain
Body:
<html><head><title>Forbidden - Contracts Finder</title></head><body><p><h1><strong>Request forbidden</strong></h1></p><p>The request rate limit may have been exceeded. If you believe this is an error <a href="https://www.contractsfinder.service.gov.uk/Home/Contact">contact us</a> quoting 0QrFmYQAAAABs5RRpp9L8RbtJ8k4jz8gwTE9OMjFFREdFMDIwOABiYTEyMjkxMi0zZWE0LTQ1NTQtYjNjNi1mNmRmZDU2MGY2ZDM=.</p></body></html>