With the /Frames endpoint user can manage Frames from the database.
GET
/api/Frames/List
Get a list of all Frames
Request Example
/api/Frames/List
RESPONSE EXAMPLE
[
{
"Id": "string",
"Name": "string",
"OutputType": "string",
"Width": Number,
"Height": Number,
"HorizontalMargin": Number,
"VerticalMargin": Number,
"HorizontalSpacing": Number,
"VerticalSpacing": Number,
"FileName": "string",
"FrameCode": "MDF2",
"ImageWidth": Number,
"ImageHeight": Number,
"ScalingRules": "string",
"ScalingMethod": "string",
"MediaType": "string",
"MediaSizeName": "string",
"AddBleed": true/false,
"BleedCover": Number,
"AddBleedAmount": "string",
"BleedAmount": null,
"BleedAmountHorizontal": Number,
"BleedAmountVertical": Number,
"BleedAmountTop": "string",
"BleedAmountBottom": "string",
"BleedAmountLeft": "string",
"BleedAmountRight": "string",
"BleedWhiteOnly": true/false,
"FrameLayout": "string",
"LocationName": "string",
"FrameType": "string"
},
{...}
]
GET
/api/Frames/Get
Get a frame
Request Example
/api/Frames/Get?id=frameId&name=frameName
Use id parameter to get frame by id or
Use name parameter to get frame by name
RESPONSE EXAMPLE
If found, a frame is returned with status code 200. Otherwise an error with code and message is returned with status code 404
{
"Id": "string",
"Name": "string",
"OutputType": "string",
"Width": Number,
"Height": Number,
"HorizontalMargin": Number,
"VerticalMargin": Number,
"HorizontalSpacing": Number,
"VerticalSpacing": Number,
"FileName": "string",
"FrameCode": "MDF2",
"ImageWidth": Number,
"ImageHeight": Number,
"ScalingRules": "string",
"ScalingMethod": "string",
"MediaType": "string",
"MediaSizeName": "string",
"AddBleed": true/false,
"BleedCover": Number,
"BleedAmount": null,
"BleedAmountHorizontal": Number,
"BleedAmountVertical": Number,
"AddBleedAmountTblr": "string",
"BleedAmountTop": "string",
"BleedAmountBottom": "string",
"BleedAmountLeft": "string",
"BleedAmountRight": "string",
"BleedWhiteOnly": true/false,
"FrameLayout": "string",
"LocationName": "string",
"FrameType": "string"
}
POST
/api/Frames/Create
Create a frame
Model Request Example
wideformatframe - required field : FrameType, Name, OutputType
{
"FrameType" : "wideformatframe",
"Name": "string1",
"OutputType": "print-template",
"MediaType": "string",
"FrameCode": "string",
"MediaSizeName": "string",
"ImageWidth": number,
"ImageHeight": number,
"ScalingRules": number,
"ScalingMethod": number,
"AddBleed": true/false,
"BleedWhiteOnly": true/false,
"AddBleedAmount" : "bleedamount or bleedamounthorvert or bleedamounttblr" , // requreid if if Add Bleed is enabled
"BleedCover": 1, //required if Add Bleed is enabled.
//A value is required for at least 1 section of bleed values if Add Bleed is enabled.
// option 1, required if AddBleedAmount is bleedamount
"BleedAmount": number
// option 2, required if AddBleedAmount is bleedamounthorvert
"BleedAmountHorizontal": number,
"BleedAmountVertical": number,
// option 3, required if AddBleedAmount is bleedamounttblr
"BleedAmountTop": number
"BleedAmountBottom": number,
"BleedAmountLeft": number,
"BleedAmountRight": number
}
DTG Frame - required field : FrameType, Name, OutputType
{
"FrameType" : "dtgframe",
"Name": "string",
"OutputType": "print-template",
"HorizontalMargin": Number,
"VerticalMargin": Number,
"HorizontalSpacing": Number,
"VerticalSpacing": Number
}
Cutter Frame - required field : FrameType, Name, OutputType
{
"FrameType" : "Cutter Frame",
"Name": "string",
"OutputType": "print-template",
"HorizontalMargin": Number,
"VerticalMargin": Number,
"ImageWidth": Number,
"ImageHeight": Number,
"HorizontalSpacing": Number,
"VerticalSpacing": Number
}
gig - Content-Type must be multipart/form-data, required field : FrameType, Name, OutputType, file
file - pv file
FrameType - "gig"
OutputType - output type
Name - frame name
Response Example
If the operation is successful a frame will be returned with status code 201
Otherwise an error with code and message will be returned with status code 409
PUT
/api/Frames/Update
Update a frame
Request Example
/api/Frames/Update?id=frameId&name=frameName
Use id parameter to identify the frame to update by id or
Use name parameter to identify the frame to update by name
Model Request Example
All fields are updated
wideformatframe - required field : FrameType, Name, OutputType
{
"FrameType" : "wideformatframe",
"Name": "string1",
"OutputType": "print-template",
"MediaType": "string",
"FrameCode": "string",
"MediaSizeName": "string",
"ImageWidth": number,
"ImageHeight": number,
"ScalingRules": number,
"ScalingMethod": number,
"AddBleed": true/false,
"BleedWhiteOnly": true/false,
"AddBleedAmount" : "bleedamount or bleedamounthorvert or bleedamounttblr" , // requreid if if Add Bleed is enabled
"BleedCover": 1, //required if Add Bleed is enabled.
//A value is required for at least 1 section of bleed values if Add Bleed is enabled.
// option 1, required if AddBleedAmount is bleedamount
"BleedAmount": number
// option 2, required if AddBleedAmount is bleedamounthorvert
"BleedAmountHorizontal": number,
"BleedAmountVertical": number,
// option 3, required if AddBleedAmount is bleedamounttblr
"BleedAmountTop": number
"BleedAmountBottom": number,
"BleedAmountLeft": number,
"BleedAmountRight": number
}
DTG Frame - required field : FrameType, Name, OutputType
{
"FrameType" : "dtgframe",
"Name": "string",
"OutputType": "print-template",
"HorizontalMargin": Number,
"VerticalMargin": Number,
"HorizontalSpacing": Number,
"VerticalSpacing": Number
}
Cutter Frame - required field : FrameType, Name, OutputType
{
"FrameType" : "Cutter Frame",
"Name": "string",
"OutputType": "print-template",
"HorizontalMargin": Number,
"VerticalMargin": Number,
"ImageWidth": Number,
"ImageHeight": Number,
"HorizontalSpacing": Number,
"VerticalSpacing": Number
}
gig - Content-Type must be multipart/form-data, required field : FrameType, Name, OutputType, file
file - pv file
FrameType - "gig"
OutputType - output type
Name - frame name
Response Example
If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409
DELETE
/api/Frames/Delete
Delete a frame
Request Example
/api/Frames/Delete?id=frameId&name=frameName
Use id parameter to identify the frame to update by id or
Use name parameter to identify the frame to delete by name
Response Example
If the operation is successful an empty response will be returned with status code 200
Otherwise an error with code and message will be returned with status code 409