POST Draft/AdditionalDetail/Add

This operation is to be used to upload additional information relating to a single notice. The payload consists of a single additional detail definition. The operation requires the identity of a previously created notice, with which the additional detail data will be associated. This requires the caller to have access to the GUID identifying the notice, which could be obtained using Draft/Notices/Lookup.

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 AdditionalDetail object to associate with the specified notice.

AdditionalDetail

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 the identity of the updated notice; otherwise a collection of errors with HTTP status 400.

globally unique identifier

Response Formats

application/json, text/json

Sample:

"5d152899-3486-49f8-a0b1-8f357671bb09"

application/xml, text/xml

Sample:

<guid xmlns="http://schemas.microsoft.com/2003/10/Serialization/">5d152899-3486-49f8-a0b1-8f357671bb09</guid>