POST v1/Content/{designId}
Retrieve a subset of content files
URI template
v1/Content/{designId}?useCdn={useCdn}Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
designId |
desingId |
integer |
Required |
useCdn | boolean |
Default value is True |
Body Parameters
files to retrieve
Collection of InFileName | Description | Type | Additional information |
---|---|---|---|
FileName |
Filename of the content to retrieve |
string |
None. |
LastRetrievedDate |
Last datetime the file was retrieved. Null value will retrieve the file, otherwise it will check if file in database was modified and return the new content. |
date |
None. |
Request Formats
application/json, text/json
Sample:
[ { "$id": "1", "FileName": "sample string 1", "LastRetrievedDate": "2025-04-25T09:23:35.2745865" }, { "$id": "2", "FileName": "sample string 3", "LastRetrievedDate": "2025-04-25T09:23:35.2745865" } ]
application/xml, text/xml
Sample:
<ArrayOfInFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Inbound"> <InFile> <FileName>sample string 1</FileName> <LastRetrievedDate>2025-04-25T09:23:35.2745865</LastRetrievedDate> </InFile> <InFile> <FileName>sample string 3</FileName> <LastRetrievedDate>2025-04-25T09:23:35.2745865</LastRetrievedDate> </InFile> </ArrayOfInFile>
Response Information
Resource Description
Collection of ContentFile
Name | Description | Type | Additional information |
---|---|---|---|
FileName |
Get or set the FileName property |
string |
None. |
Content |
Get or set the Content property |
Collection of byte |
None. |
LastModifiedTimestamp |
Get or set the DesignId property |
date |
None. |
Status |
Get or set the Status of the cotent file request |
ContentFileStatus |
None. |
Response Formats
application/json, text/json
Sample:
[ { "$id": "1", "FileName": "sample string 1", "Content": "QEA=", "LastModifiedTimestamp": "2025-04-25T09:23:35.2904648", "Status": 1 }, { "$id": "2", "FileName": "sample string 5", "Content": "QEA=", "LastModifiedTimestamp": "2025-04-25T09:23:35.2904648", "Status": 1 } ]
application/xml, text/xml
Sample:
<ArrayOfContentFile xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OnlineOrderingAPI.Models.v1"> <ContentFile> <Content>QEA=</Content> <FileName>sample string 1</FileName> <LastModifiedTimestamp>2025-04-25T09:23:35.2904648</LastModifiedTimestamp> <Status>Latest</Status> </ContentFile> <ContentFile> <Content>QEA=</Content> <FileName>sample string 5</FileName> <LastModifiedTimestamp>2025-04-25T09:23:35.2904648</LastModifiedTimestamp> <Status>Latest</Status> </ContentFile> </ArrayOfContentFile>