editor
725
edits
Changes
Jump to navigation
Jump to search
Created page with "{{Api_Method_Spec| Description=Get the instance payments settings available on the instance. The result is default ordered by ReleaseDate. |Parameters= {{Api_Parameter| Par..."
{{Api_Method_Spec|
Description=Get the instance payments settings available on the instance.
The result is default ordered by ReleaseDate.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=The offset number of the returned values for this request
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=The limit number of values for this request
}}
{{Api_Parameter|
ParamName=personId
|ParamType=int
|ParamRequired=required
|ParamDescription=The number (ID) of one person that wants to be returned on the request.
}}
{{Api_Parameter|
ParamName=role
|ParamType=int
|ParamRequired=optional
|ParamDescription=Set a filter to return only product that the person has the role defined.
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result. Default set to Movie and Season (1, 3).
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType= [[adultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=SortTypeId to order result by the chosen field. Default ordered by Title property.
}}
|Returns=
Returns a JSON object containing an array of [[Products]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;"> Array of [[Product]] objects</span> ]
}
|Exceptions=
* None
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=Get the instance payments settings available on the instance.
The result is default ordered by ReleaseDate.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=offset
|ParamType=int
|ParamRequired=optional
|ParamDescription=The offset number of the returned values for this request
}}
{{Api_Parameter|
ParamName=limit
|ParamType=int
|ParamRequired=optional
|ParamDescription=The limit number of values for this request
}}
{{Api_Parameter|
ParamName=personId
|ParamType=int
|ParamRequired=required
|ParamDescription=The number (ID) of one person that wants to be returned on the request.
}}
{{Api_Parameter|
ParamName=role
|ParamType=int
|ParamRequired=optional
|ParamDescription=Set a filter to return only product that the person has the role defined.
}}
{{Api_Parameter|
ParamName=typeFilter
|ParamType=String
|ParamRequired=optional
|ParamDescription=List of numbers separated by comma with the [[MovieType]] to filter the result. Default set to Movie and Season (1, 3).
}}
{{Api_Parameter|
ParamName= adultFilter
|ParamType= [[adultFilterType]]
|ParamRequired=optional
|ParamDescription=Type to represent Unknown, All, AdultOnly or NonAdultOnly. If the content is for adult and/or not adult or both. The default value is NonAdultOnly.
}}
{{Api_Parameter|
ParamName= sort
|ParamType= [[movieSortType]]
|ParamRequired=optional
|ParamDescription=SortTypeId to order result by the chosen field. Default ordered by Title property.
}}
|Returns=
Returns a JSON object containing an array of [[Products]].
'''Example:'''
{
: <span style="color: #a11;">"Offset"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Limit"</span>: <span style="color: #164;">100</span>,
: <span style="color: #a11;">"Count"</span>: <span style="color: #164;">6</span>,
: <span style="color: #a11;">"List"</span>:
:: [ <span style="color: #219;"> Array of [[Product]] objects</span> ]
}
|Exceptions=
* None
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
