PUT api/screen/info/{screenId}

Request Information

URI Parameters

Name	Description	Type	Additional information
screenId		globally unique identifier	Required

Body Parameters

Screen

Name	Type	Additional information
ScreenId	globally unique identifier	None.
CategoryId	globally unique identifier	None.
Name	string	None.
Description	string	None.
Width	integer	None.
Height	integer	None.
ScaleMode	string	None.
BackgroundColor	string	None.
BackgroundImage	string	None.
Thumbnail	string	None.
Cover	string	None.
Content	string	None.
Order	integer	None.
IsTemplate	boolean	None.
DateCreated	date	None.
CreatedBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "screenId": "cba2d6d3-f5f1-485a-87e7-dd13df5f0272",
  "categoryId": "d41a380b-daa9-4b98-ae04-6b33fd90dfb8",
  "name": "sample string 3",
  "description": "sample string 4",
  "width": 5,
  "height": 6,
  "scaleMode": "sample string 7",
  "backgroundColor": "sample string 8",
  "backgroundImage": "sample string 9",
  "thumbnail": "sample string 10",
  "cover": "sample string 11",
  "content": "sample string 12",
  "order": 13,
  "isTemplate": true,
  "dateCreated": "2026-01-04T18:35:26.2461108+08:00",
  "createdBy": "sample string 16"
}

application/xml, text/xml

Sample:

<Screen xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Margin.Core.Data.Entities">
  <BackgroundColor>sample string 8</BackgroundColor>
  <BackgroundImage>sample string 9</BackgroundImage>
  <CategoryId>d41a380b-daa9-4b98-ae04-6b33fd90dfb8</CategoryId>
  <Content>sample string 12</Content>
  <Cover>sample string 11</Cover>
  <CreatedBy>sample string 16</CreatedBy>
  <DateCreated>2026-01-04T18:35:26.2461108+08:00</DateCreated>
  <Description>sample string 4</Description>
  <Height>6</Height>
  <IsTemplate>true</IsTemplate>
  <Name>sample string 3</Name>
  <Order>13</Order>
  <ScaleMode>sample string 7</ScaleMode>
  <ScreenId>cba2d6d3-f5f1-485a-87e7-dd13df5f0272</ScreenId>
  <Thumbnail>sample string 10</Thumbnail>
  <Width>5</Width>
</Screen>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

ApiResult

Name	Type	Additional information
Status	ApiResultStatus	None.
Data	Object	None.
Message	string	None.
Code	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "status": "success",
  "data": {},
  "message": "sample string 2",
  "code": 1
}

application/xml, text/xml

Sample:

<ApiResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Margin.Models">
  <Code>1</Code>
  <Data />
  <Message>sample string 2</Message>
  <Status>Success</Status>
</ApiResult>