POST restapi/personal/courses/bulletins/{bulletinId}/uploadimage/v1

Upload file attachment to temporary storage. The file should be included in the post call so we can extract it as HttpContext.Current.Request.Files.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
bulletinId

The bulletin identifier.

integer

Required

Body Parameters

None.

Response Information

Resource Description

Represents information about uploading result.

Itslearning.RestApi.Entities.LightBulletins.LightBulletinOutputImageData
NameDescriptionTypeAdditional information
IsError

True if an error occurred while uploading the image.

boolean

None.

ErrorMessage

The error message when uploading an image.

Itslearning.RestApi.Entities.LocalizedText

None.

PreviewFile

The file information, that contains preview for attached image.

Itslearning.RestApi.Entities.Updatable.FileDataV1

None.

OriginalFile

The file information, that contains attached image.

Itslearning.RestApi.Entities.Updatable.FileDataV1

None.

Response Formats

application/json, text/json

Sample:
{
  "IsError": true,
  "ErrorMessage": {
    "LocalizedKey": "sample string 1",
    "LocalizedArgs": [
      "sample string 1",
      "sample string 2"
    ]
  },
  "PreviewFile": {
    "FileId": "sample string 1",
    "Signature": "sample string 2",
    "FileName": "sample string 3"
  },
  "OriginalFile": {
    "FileId": "sample string 1",
    "Signature": "sample string 2",
    "FileName": "sample string 3"
  }
}

application/xml, text/xml

Sample:
<LightBulletinOutputImageData xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
  <OriginalFile>
    <FileId>sample string 1</FileId>
    <FileName>sample string 3</FileName>
    <Signature>sample string 2</Signature>
  </OriginalFile>
  <PreviewFile>
    <FileId>sample string 1</FileId>
    <FileName>sample string 3</FileName>
    <Signature>sample string 2</Signature>
  </PreviewFile>
  <ErrorMessage>
    <LocalizedArgs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>sample string 1</d3p1:string>
      <d3p1:string>sample string 2</d3p1:string>
    </LocalizedArgs>
    <LocalizedKey>sample string 1</LocalizedKey>
  </ErrorMessage>
  <IsError>true</IsError>
</LightBulletinOutputImageData>