POST Draft/AdditionalDetail/Update

This operation allows an individual additional detail to be updated. The provided AdditionalDetail object identifies the additional detail and describes its updated state.

Requires Authorization

The endpoint requires a bearer token in the http authorization header. For example "bearer 2YotnFZFEjr1zCsicMWpAA"

Request Information

URI Parameters

None.

Body Parameters

An updated AdditionalDetail object.

AdditionalDetail

To 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>
For example: https://www.contractsfinder.service.gov.uk/Notice/Attachment/c3c27b8a-f404-45de-bf62-48c5cdc5e0ec

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.

Request Formats

application/json, text/json

Sample:

{
  "id": "c3c27b8a-f404-45de-bf62-48c5cdc5e0ec",
  "noticeId": "d31c1dfb-462c-42f6-ab22-6860cc3a65b0",
  "description": "Document attachment",
  "dataType": "Attachment",
  "documentType": "technicalSpecifications",
  "textData": null,
  "link": null,
  "mimeType": "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
  "filename": "Proposal.docx",
  "fileContent": "UgBhAHcAIABmAGkAbABlACAAZABhAHQAYQA=",
  "awardGuid": null
}

application/xml, text/xml

Sample:

<AdditionalDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
  <AwardGuid i:nil="true" />
  <DataType>Attachment</DataType>
  <DocumentType>technicalSpecifications</DocumentType>
  <Description>Document attachment</Description>
  <FileContent>UgBhAHcAIABmAGkAbABlACAAZABhAHQAYQA=</FileContent>
  <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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Returns HTTP status 200 if successful; otherwise a collection of errors with HTTP status 400.

ServiceResponse

Name	Description	Type	Additional information
Code		ServiceResponseCode	None.
Errors		Collection of Error	None.

Response Formats

application/json, text/json

Sample:

{
  "code": "Ok",
  "errors": null
}