POST api/rest/2/add_draft_award/{MimeType}

For the Version 1 equivalent method, please visit POST Draft/Award/Add. However please note that whilst we are still supporting Version 1 methods for the foreseeable future to provide backwards compatibility, they should be considered deprecated and we encourage the use of this Version 2 method.

This operation is used to award a single notice. The payload consists of a single award definition. The operation requires the identity of a previously created notice with which the award data will be associated. The caller needs 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

The AwardDetail to add.

AwardDetail

Name	Description	Type	Additional information
Id	The unique id of the award. (Assigned by the system at creation, should only be supplied for subsequent updates and actions).	integer	None.
NoticeId	The GUID identifying the notice that this award relates to.	globally unique identifier	None.
ParentId	The unique id of the parent award.	integer	None.
Value	The value of the award in GBP.	decimal number	None.
SupplierName	The name of the supplier the contract has been awarded to.	string	None.
SupplierAddress	The address of the supplier.	string	None.
Contact	A contact name for the supplier.	string	None.
DunsNumber	The DUNS number for the supplier, if known.	string	None.
ReferenceType	The type of reference being passed.	ReferenceType	None.
Reference	The reference value of the Reference type specified in the ReferenceType field.	string	None.
SupplierAwardedValue	The value of the award for the individual supplier in GBP.	double	None.
StartDate	The start date of the awarded contract.	date	None.
EndDate	The end date of the awarded contract.	date	None.
AwardedDate	The date of the award.	date	None.
AwardedProcedureType	The awarded contract procedure type.	AwardedProcedureType	None.
AwardedProcedureTypeOther	Gets or sets the other procedure detail	String	None.
AwardedProcedureAcceleratedJustification	Gets or sets justification of accelerated procedure	String	None.
AnnexDOptionType	The Annex D option, where applicable.	AnnexDOptionType	None.
ReasonContractLawful	The reason why this contract is lawful, where applicable.	string	None.
AdditionalDetails	Additional details for this award/supplier	string	None.
AwardedToSME	Gets or sets a value indicating whether this opportunity was awarded to a SME.	boolean	None.
AwardedToVCSO	Gets or sets a value indicating whether this opportunity was awarded to a VCSO.	boolean	None.
AwardGuid	Gets or sets a GUID as an enduring identifier through draft and publication	globally unique identifier	None.

AwardDetail

Request Formats

application/json, text/json

Sample:

{
  "id": 1,
  "noticeId": "2e3ee6d0-593a-4077-96ce-4632caf5cff5",
  "parentId": null,
  "value": 5000.0,
  "supplierName": "Supplies Ltd",
  "supplierAddress": "Warehouse 3, Triangle Estate, Reading, RG1 1BB",
  "contact": "Joe Bloggs",
  "dunsNumber": "987654321",
  "referenceType": "COMPANIES_HOUSE",
  "reference": "123456789",
  "supplierAwardedValue": 100.0,
  "startDate": "2015-06-01T00:00:00",
  "endDate": "2015-09-01T00:00:00",
  "awardedDate": "2015-03-01T00:00:00",
  "awardedProcedureType": "Open",
  "annexDOptionType": null,
  "reasonContractLawful": null,
  "additionalDetails": null,
  "awardedToSME": false,
  "awardedToVCSO": false,
  "awardGuid": null
}

application/xml, text/xml

Sample:

<AwardDetail xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IPL.ContractsFinder.BusinessEntities">
  <AdditionalDetails i:nil="true" />
  <AnnexDOptionType i:nil="true" />
  <AwardGuid i:nil="true" />
  <AwardedDate>2015-03-01T00:00:00</AwardedDate>
  <AwardedProcedureType>Open</AwardedProcedureType>
  <AwardedToSME>false</AwardedToSME>
  <AwardedToVCSO>false</AwardedToVCSO>
  <Contact>Joe Bloggs</Contact>
  <DunsNumber>987654321</DunsNumber>
  <EndDate>2015-09-01T00:00:00</EndDate>
  <Id>1</Id>
  <NoticeId>2e3ee6d0-593a-4077-96ce-4632caf5cff5</NoticeId>
  <ParentId i:nil="true" />
  <ReasonContractLawful i:nil="true" />
  <StartDate>2015-06-01T00:00:00</StartDate>
  <SupplierAddress>Warehouse 3, Triangle Estate, Reading, RG1 1BB</SupplierAddress>
  <SupplierName>Supplies Ltd</SupplierName>
  <Value>5000.0</Value>
  <ReferenceType>COMPANIES_HOUSE</ReferenceType>
  <Reference>123456789</Reference>
  <SupplierAwardedValue>100.0</SupplierAwardedValue>
</AwardDetail>

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
}

application/xml, text/xml

Sample:

<ServiceResponse>
    <Code>Ok</Code>
    <Errors i:nil="true" />
</ServiceResponse>