JSON Formats

Below are the descriptions of the formats used in cielo24 API.

Job Info Format

The following defines the Job Info in JSON format:

{
    "JobId" : "<Guid HexString>",
    "JobName" : "<String>",
    "MediaLengthSeconds" : "<Float>",
    "ExternalID" : "<String (dependant on third-party integrations)",
    "Priority" : "<Priority Enum>",
    "Fidelity" : "<Fidelity Enum>",
    "JobStatus" : "<JobStatus Enum>",
    "Options" : {
        "<JobConfigOption>" : "<Value>"
        ...
    },
    "ReturnTargets" : {
        "<ReturnTargetName>" : "<ReturnTargetValue>",
        ...
    },
    "SourceLanguage" : "<RFC 5646 Language Code>",
    "TargetLanguage" : "<RFC 5646 Language Code>",
    "CreationDate" : "<ISO 8601 Date String>",
    "StartDate" : "<ISO 8601 Date String>",
    "DueDate" : "<ISO 8601 Date String>",
    "CompletedDate" : "<ISO 8601 Date String>",
    "ReturnDate": "<ISO 8601 Date String>",
    "AuthorizationDate": "<ISO 8601 Date String>",
    "JobDifficulty" : "<JobDifficulty Enum>"
}

Related: Priority Enumeration, Fidelity Enumeration, Job Status Enumeration, JobDifficulty Enumeration .

Job List Format

The following defines the Job List in JSON format:

{
    "Username" : "<String>",
    "ActiveJobs" :
    [
        "List of Jobs (see below)"
    ]
}

Job Format

The following defines the Job in JSON format:

{
    "JobId" : "<Guid HexString>",
    "JobName" : "<String>",
    "Username": "<String>",
    "MediaLengthSeconds" : "<Float>",
    "ExternalID" : "<String (dependant on third-party integrations)",
    "Priority" : "<Priority Enum>",
    "Fidelity" : "<Fidelity Enum>",
    "JobStatus" : "<JobStatus Enum>",
    "SourceLanguage" : "<RFC 5646 Language Code>",
    "TargetLanguage" : "<RFC 5646 Language Code>",
    "CreationDate" : "<ISO 8601 Date String>",
    "StartDate" : "<ISO 8601 Date String>",
    "DueDate" : "<ISO 8601 Date String>",
    "CompletedDate" : "<ISO 8601 Date String>",
    "ReturnDate": "<ISO 8601 Date String>",
    "AuthorizationDate": "<ISO 8601 Date String>",
    "JobDifficulty": "<JobDifficulty Enum>",
    "Options" : {
        "<JobConfigOption>" : "<Value>"
        ...
    },
    "ReturnTargets" : {
        "<ReturnTargetName>" : "<ReturnTargetValue>",
        ...
    }
}

Related: Fidelity Enumeration, Priority Enumeration, Job Status Enumeration, JobDifficulty Enumeration .

Error Format

The following defines the Error Output in JSON format:

{
    "ErrorType" : "<ErrorType Enum>",
    "ErrorComment" : "<String>"
}

Related: Error Type Enumeration.

ElementList List Format

The following defines the ElementList list in JSON format:

[{
    "iwp_name" : "<String>",
    "version" : "<ISO 8601 Date String>"
}]