Allows to add single transfer order.
FIELD | DESCRIPTION |
_type |
Optional. String. Either "transfer", "key", or "both". Default is "transfer". An API user, allowed to create key orders, can provide this field and depending on its value we will create either only a transfer order when _type is "transfer", only a key order when _type is "key", or both a transfer and a key order when _type is "both". |
assetUuid |
Optional. String. The UUID of an asset map or a composition playlist. |
assetUuids |
Optional. Array of Strings. See above; providing UUIDs of both asset maps and composition playlists isn't supported. |
versionId |
Optional. String. The _id of a version that may contain one or more composition playlists. |
versionIds |
Optional. Array of Strings. See above; providing _ids of versions for multiple titles isn't supported. |
bundleId |
Optional. String. The _id of a bundle that may contain one or more versions and / or composition playlists. |
bundleIds |
Optional. Array of Strings. See above; providing _ids of bundles for multiple titles isn't supported. |
title |
Optional. Object. Provide this when either all assets should belong to this specified title or a new title that doesn't already exist should be created. In the later case, the user should be allowed to create a new title for the request to be accepted. |
title._id | Optional. String. |
title.identifier | Optional. Object. |
title.identifier.source | Required. String. |
title.identifier.value | Required. String. |
title.name | Optional. String. |
title.releaseDate | Optional. String. Date format ISO-8601 |
versions |
Optional. Array of Objects. If a title is provided, we'll also allow new versions to be explicitly specified (as well as implicitly creating them for any asset UUID that we don't know or any provided versionIds and bundleIds). As with creating new titles, the user should be allowed to create new versions for the request to be accepted. |
versions.$ | Optional. Object. |
versions.$.uuid | Optional. String. |
versions.$.description | Optional. String. |
versions.$.contentKind |
Optional. String. One of: "advertisement", "clip", "feature", "policy", "public service announcement", "promo", "rating tag", "short", "stereocard", "teaser", "test", "trailer", "transitional", "unknown" |
versions.$.video | Optional. Object. |
versions.$.video.type | Optional. String. |
versions.$.video.stereoscopic | Optional. Boolean |
versions.$.audio | Optional. Object. |
versions.$.audio.type | Optional. String. |
versions.$.audio.languages | Optional. Array of Strings. |
versions.$.subtitles | Optional. Object. |
versions.$.subtitles.type | Optional. String. |
versions.$.subtitles.languages | Optional. Array of Strings. |
versions.$.motion | Optional. String. |
ownerId |
Optional. String. Provide this (or the ownerIdentifier object below ) if there is the possibility of confusion about which content owner this order should be made for. |
ownerIdentifier |
Optional. Object. Provide this (or the ownerId string above) if there is the possibility of confusion about which content owner this order should be made for. |
ownerIdentifier.source | Required if the ownerIdentifier object is provided. String. |
ownerIdentifier.value | Required if the ownerIdentifier object is provided. String. |
bookerId |
Optional. String. Provide this (or the bookerIdentifier object below ) if there is the possibility of confusion about which booker this order should be made for. |
bookerIdentifier |
Optional. Object. Provide this (or the bookerId string above) if there is the possibility of confusion about which booker this order should be made for. |
bookerIdentifier.source | Required if the bookerIdentifier object is provided. String. |
bookerIdentifier.value | Required if the bookerIdentifier object is provided. String. |
company | Required. Object. |
company._id | Required if no identifier (see below) is specified. String. |
company.identifier | Required if no Gofilex company _id (see above) is specified. Object. |
company.identifier.source | Required. String. |
company.identifier.value | Required. String. |
company.country |
Optional. String. The ISO code of the company's country. |
medium |
Optional. String. Either "electronic" or "physical". Defaults to being automatically selected, preferring "electronic" deliveries. |
source |
Optional. String. Either "internal" or "keygen". Defaults to being automatically selected, preferring to generate keys internally. |
expected |
Optional. Boolean. An expected order merely indicates that the receiving company expects to need this content in the near future but requires e.g. the content owner to make their own order before the content is actually made available. Some API users are only allowed to make expected orders and don't have to pass this flag to do so. |
transferAfter |
Optional. String. Date format ISO-8601 The date/time the transfer should start after. If you leave out the timezone offset the time will be used as the wall-clock time in the company's local timezone. |
releaseAfter |
Optional. String. Date format ISO-8601 The date/time the transfer should be released to the site. If you leave out the timezone offset the time will be used as the wall-clock time in the company's local timezone. |
deliveryDue |
Required. String. Date format ISO-8601 The date/time the transfer should ultimately be present at the site. If you leave out the timezone offset the time will be used as the wall-clock time in the company's local timezone. |
description | Optional. String. |
validity |
Optional. Object. This is required when the _type field is provided with a value of either "key" or "both". |
validity.start |
Required. String. Date format ISO-8601 The date/time the generated keys should be valid after. If you leave out the timezone offset the time will be used as the wall-clock time in the company's local timezone. |
validity.end |
Required. String. Date format ISO-8601 The date/time the generated keys should be valid until. If you leave out the timezone offset the time will be used as the wall-clock time in the company's local timezone. |
additionalText |
Optional. String. The contents of this field will be added to the email notification that is sent out to clients when the ordered content is delivered. |
EMEA Portal
https://genie.portal.gofilex.com/api/method/v1/order/add/transfer
curl -vX POST https://genie.portal.gofilex.com/api/method/v1/order/add/transfer -d @order.json --header "Content-Type: application/json" --header "Authorization: Bearer BXrnipNekltq-sHFxpjdd90S17th2Q5mSaRf_4-Rayx"
APAC Portal
https://genie.portal.apac.gofilex.com/api/method/v1/order/add/transfer
curl -vX POST https://genie.portal.apac.gofilex.com/api/method/v1/order/add/transfer -d @order.json --header "Content-Type: application/json" --header "Authorization: Bearer BXrnipNekltq-sHFxpjdd90S17th2Q5mSaRf_4-Rayx"
MPS Portal
https://genie.portal.mps.gofilex.com/api/method/v1/order/add/transfer
curl -vX POST https://genie.portal.mps.gofilex.com/api/method/v1/order/add/transfer -d @order.json --header "Content-Type: application/json" --header "Authorization: Bearer BXrnipNekltq-sHFxpjdd90S17th2Q5mSaRf_4-Rayx"
NORAM Portal
https://genie.portal.gofilex.bydeluxe.com/api/method/v1/order/add/transfer
curl -vX POST https://genie.portal.gofilex.bydeluxe.com/api/method/v1/order/add/transfer -d @order.json --header "Content-Type: application/json" --header "Authorization: Bearer BXrnipNekltq-sHFxpjdd90S17th2Q5mSaRf_4-Rayx"
order.json
{
"assetUuids": [
"3b562358-e9ab-4f69-acb5-b0df5f2dd555",
"23a62988-01f4-47ce-9772-1c33aa629d6f"
],
"company": {
"identifier": {
"source": "nff",
"value": "1.337"
}
},
"deliveryDue": "2018-12-05T12:00:00.000Z"
}
{
"success": true,
"order": {
"_type": "transfer",
"description": "Gofilex Leader",
"_status": {
"state": "pending"
},
"_owner": {
"_id": "HKDd83r8Qy6acvY3R",
"location": {
"countries": [
"BE",
"LU",
"NL",
]
},
"name": "Gofilex Distribution"
},
"title": {
"_id": "LdtBsWqxMsg2rgnie",
"name": "Gofilex Leader"
},
"company": {
"_id": "aNDMD3ebP6Zvmkxwm",
"location": {
"countries": [
"NL"
],
"city": "Zeist",
"timezone": "Europe/Amsterdam"
},
"name": "Gofilex Cinema",
"type": "cinema"
},
"compositionPlaylists": [
{
"_id": "y2iKhC7gw28CiJjJJ",
"uuid": "888c53d9-4ee5-45b8-8f03-ab7ec89c4d85",
"contentKind": "transitional"
},
{
"_id": "TxnZMptcFE5YNyBQT",
"uuid": "916844f4-3b3a-40bc-85e3-5c267a831e22",
"contentKind": "transitional"
}
],
"_derived": {
"versions": [],
"compositionPlaylists": [
{
"_id": "y2iKhC7gw28CiJjJJ",
"uuid": "888c53d9-4ee5-45b8-8f03-ab7ec89c4d85",
"contentKind": "transitional"
},
{
"_id": "TxnZMptcFE5YNyBQT",
"uuid": "916844f4-3b3a-40bc-85e3-5c267a831e22",
"contentKind": "transitional"
}
],
"digitalCinemaPackages": [
{
"_id": "sJc68mnp6jtxh3DJ2",
"uuid": "23a62988-01f4-47ce-9772-1c33aa629d6f"
},
{
"_id": "sd8wXzwx4b2e75oBT",
"uuid": "3b562358-e9ab-4f69-acb5-b0df5f2dd555"
}
]
},
"details": {
"video": {
"type": [
"standard",
"standard"
],
"aspectRatio": [
"scope",
"flat"
],
"resolution": [
"2K",
"2K"
],
"frameRate": [
24,
24
],
"stereoscopic": [
false,
false
]
},
"audio": {
"type": [
"5.1",
"5.1"
],
"languages": []
},
"subtitles": {
"type": [
"open",
"open"
],
"languages": [
"eng",
"eng"
]
},
"motion": {
"type": [
"none",
"none"
]
},
"contentKind": [
"transitional",
"transitional"
],
"encrypted": []
},
"deliveryDue": "2018-12-05T12:00:00.000Z",
"transferAfter": "2018-11-30T08:00:00.000Z",
"releaseAfter": "2018-11-30T08:00:00.000Z",
"medium": "electronic",
"direction": "delivery",
"_id": "6qHGWHR9XqqeHqLKr"
}
}
Most fields are self-explaining but here is some detail about a few of them: