Needio.Services

<back to all web services

AddMenuItemMediaRequest

Requires Authentication
Required role:Approved
The following routes are available for this service:
All Verbs/Post/AddMenuItemMedia/
AddMenuItemMediaRequest Parameters:
NameParameterData TypeRequiredDescription
MediaqueryMediaDTONo
Blobquerybyte[]No
Base64querystringNo
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
startformDateTimeNo
DeviceUUIDformstringNo
APIKeyformstringNo
AddMenuItemMediaResponse Parameters:
NameParameterData TypeRequiredDescription
MediaformMediaDTONo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformboolNo
ResMessageformstringNo
ErrorformErrorNo
PageInfoformBasePageInfoNo
Error Parameters:
NameParameterData TypeRequiredDescription
ErrorYnformboolNo
ErrorCodeformstringNo
ErrorDescriptionformstringNo
BasePageInfo Parameters:
NameParameterData TypeRequiredDescription
TotalRecordCountformintNo
TotalPageCountformintNo
CurrentPageformintNo
MediaDTO Parameters:
NameParameterData TypeRequiredDescription
PostIdformintNo
MediaIdformint?No
UsageTypeformUsageTypesNo
MediaTypeformMediaTypesNo
SourceformstringNo
MediaFileNameformstringNo
MediaMimeformstringNo
IsMainformboolNo
RefIdformint?No
OrderNumformintNo
ActionformDBActionNo
IsDeletedformboolNo
FriendlyURLformstringNo
PostVariantA1KeyformstringNo
SourceUrlformstringNo
ActiveYnformboolNo
UsageTypes Enum:
NameValue
StoreMedias1
StoreFiles2
MediaTypes Enum:
NameValue
icon0
Image1
Video2
Youtube3
Pdf8
File9
ThreeD10
Custom99
DBAction Enum:
NameValue
None0
Insert1
Update2
Delete3
AddMenuItemMediaResponse Parameters:
NameParameterData TypeRequiredDescription
MediaformMediaDTONo

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Post/AddMenuItemMedia/ HTTP/1.1 
Host: baseservices.needion.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<AddMenuItemMediaRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <APIKey>String</APIKey>
  <DeviceUUID>String</DeviceUUID>
  <Base64>String</Base64>
  <Blob>AA==</Blob>
  <Media xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:Action>None</d2p1:Action>
    <d2p1:ActiveYn>false</d2p1:ActiveYn>
    <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:IsMain>false</d2p1:IsMain>
    <d2p1:MediaFileName>String</d2p1:MediaFileName>
    <d2p1:MediaId>0</d2p1:MediaId>
    <d2p1:MediaMime>String</d2p1:MediaMime>
    <d2p1:MediaType>icon</d2p1:MediaType>
    <d2p1:OrderNum>0</d2p1:OrderNum>
    <d2p1:PostId>0</d2p1:PostId>
    <d2p1:PostVariantA1Key>String</d2p1:PostVariantA1Key>
    <d2p1:RefId>0</d2p1:RefId>
    <d2p1:Source>String</d2p1:Source>
    <d2p1:SourceUrl>String</d2p1:SourceUrl>
    <d2p1:UsageType>StoreMedias</d2p1:UsageType>
  </Media>
</AddMenuItemMediaRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<AddMenuItemMediaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2">
  <Error>
    <ErrorCode>String</ErrorCode>
    <ErrorDescription>String</ErrorDescription>
    <ErrorYn>false</ErrorYn>
  </Error>
  <PageInfo>
    <CurrentPage>0</CurrentPage>
    <TotalPageCount>0</TotalPageCount>
    <TotalRecordCount>0</TotalRecordCount>
  </PageInfo>
  <ResMessage>String</ResMessage>
  <Result>false</Result>
  <Media xmlns:d2p1="http://schemas.datacontract.org/2004/07/Needio.Services.ServiceModel.v2.Models">
    <d2p1:Action>None</d2p1:Action>
    <d2p1:ActiveYn>false</d2p1:ActiveYn>
    <d2p1:FriendlyURL>String</d2p1:FriendlyURL>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:IsMain>false</d2p1:IsMain>
    <d2p1:MediaFileName>String</d2p1:MediaFileName>
    <d2p1:MediaId>0</d2p1:MediaId>
    <d2p1:MediaMime>String</d2p1:MediaMime>
    <d2p1:MediaType>icon</d2p1:MediaType>
    <d2p1:OrderNum>0</d2p1:OrderNum>
    <d2p1:PostId>0</d2p1:PostId>
    <d2p1:PostVariantA1Key>String</d2p1:PostVariantA1Key>
    <d2p1:RefId>0</d2p1:RefId>
    <d2p1:Source>String</d2p1:Source>
    <d2p1:SourceUrl>String</d2p1:SourceUrl>
    <d2p1:UsageType>StoreMedias</d2p1:UsageType>
  </Media>
</AddMenuItemMediaResponse>