POST api/v1/delivery

Deliver a file via payload. The file is required to be sent as a string binary.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
contract	An identifier for this delivery specification	string	None.
orgNr	Organisation number for the public company. Ten digits, no dash.	string	None.
fileObject	File to be sent	FileObject	None.
test	An optional flag that if present and also set to true, instructs the API to treat this specific delivery as an intended test. The content of the delivered file will in this case neither be persisted or further used by SCB.	boolean	None.
externalVersionId	Optional value for selecting specific delivery format other than default delivery format.	string	None.
deliveryFormatName	Optional value for selecting specific delivery format name.	string	None.

Request Formats

application/json, text/json

Sample:

{
  "contract": "1",
  "orgNr": "99999999999",
  "fileObject": {
    "fileContent": "aZoarR0_Lx=....."
  },
  "test": true,
  "externalVersionId": "Ver1",
  "deliveryFormatName": "Format1"
}

application/xml, text/xml

Sample:

<FileDeliveryPostObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HydraHelpPage.Models">
  <contract>1</contract>
  <deliveryFormatName>Format1</deliveryFormatName>
  <externalVersionId>Ver1</externalVersionId>
  <fileObject>
    <fileContent>aZoarR0_Lx=.....</fileContent>
  </fileObject>
  <orgNr>99999999999</orgNr>
  <test>true</test>
</FileDeliveryPostObject>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'FileDeliveryPostObject'.

Response Information

Resource Description

Guid that can be used to check status and deliveries

string

Response Formats

application/json, text/json

Sample:

"sample string 1"

application/xml, text/xml

Sample:

<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>