Response [200 Ok]
| Uri | /api/v2/node/6sjzJx!children?start=1&count=10 |
|---|---|
| UriDescription | Child nodes of the given node. |
| EndpointType | ChildNodes |
| Locator | Node |
| LocatorType | Objects |
Node [1 of 1]
- Videos
/api/v2/node/tszQhH
| Uri | /api/v2/node/tszQhH |
|---|---|
| UriDescription | Node with the given id. |
| ResponseLevel | Public |
| DateAdded | 2009-04-09T13:37:06+00:00 |
| DateModified | 2009-04-09T13:49:38+00:00 |
| Description | empty string |
| EffectiveSecurityType | None |
| HasChildren | false |
| IsRoot | false |
| Keywords | |
| Name | Videos |
| NodeID | tszQhH |
| PasswordHint | empty string |
| SecurityType | None |
| ShowCoverImage | false |
| SortDirection | Descending |
| SortIndex | 35 |
| SortMethod | DateModified |
| Type | Album |
| UrlName | Videos |
| UrlPath | /Videos/Videos |
| WebUri | https://album.seafairpirates.org/Videos/Videos |
Formatted Values
Name [html]
| html | Videos |
|---|
Description [html, text]
| html | empty string |
|---|---|
| text | empty string |
Uris
Album
/api/v2/album/nGX64V
| Uri | /api/v2/album/nGX64V |
|---|---|
| UriDescription | Album by key |
| EndpointType | Album |
| Locator | Album |
| LocatorType | Object |
HighlightImage
/api/v2/highlight/node/tszQhH
| Uri | /api/v2/highlight/node/tszQhH |
|---|---|
| UriDescription | Highlight image for a folder, album, or page |
| EndpointType | HighlightImage |
| Locator | Image |
| LocatorType | Object |
NodeComments
/api/v2/node/tszQhH!comments
| Uri | /api/v2/node/tszQhH!comments |
|---|---|
| UriDescription | Comments on a Node |
| EndpointType | NodeComments |
| Locator | Comment |
| LocatorType | Objects |
NodeCoverImage
/api/v2/node/tszQhH!cover
| Uri | /api/v2/node/tszQhH!cover |
|---|---|
| UriDescription | Cover image for a folder, album, or page |
| EndpointType | NodeCoverImage |
| Locator | Image |
| LocatorType | Object |
NodePricelist
/api/v2/node/tszQhH!pricelist
| Uri | /api/v2/node/tszQhH!pricelist |
|---|---|
| UriDescription | Get, update, or remove the pricelist mapped to this node. |
| EndpointType | NodePricelist |
| Locator | NodePricelist |
| LocatorType | Object |
ParentNode
/api/v2/node/tszQhH!parent
| Uri | /api/v2/node/tszQhH!parent |
|---|---|
| UriDescription | Parent node of the given node. |
| EndpointType | ParentNode |
| Locator | Node |
| LocatorType | Object |
ParentNodes
/api/v2/node/tszQhH!parents
| Uri | /api/v2/node/tszQhH!parents |
|---|---|
| UriDescription | Hierarchy of nodes from the given node (inclusive) to the root node. |
| EndpointType | ParentNodes |
| Locator | Node |
| LocatorType | Objects |
User
/api/v2/user/piratepics
| Uri | /api/v2/user/piratepics |
|---|---|
| UriDescription | User By Nickname |
| EndpointType | User |
| Locator | User |
| LocatorType | Object |
Pages
| Count | 1 |
|---|---|
| FirstPage | /api/v2/node/6sjzJx!children?start=1&count=10 |
| LastPage | /api/v2/node/6sjzJx!children?start=1&count=10 |
| RequestedCount | 10 |
| Start | 1 |
| Total | 1 |
Request
| Uri | /api/v2/node/6sjzJx!children?start=1&count=10 |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Notes
- _multiargs does not work at this endpoint
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/node/6sjzJx!children?start=1&count=10"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"POST": {
"Permissions": [
"Modify"
]
}
},
"Methods": [
"OPTIONS",
"GET"
],
"ParameterDescription": {
"Select": "Select one option. Options should pass only the \"Value\"."
},
"Parameters": {
"GET": [
{
"Name": "Type",
"Required": false,
"ReadOnly": false,
"Default": "All",
"Type": "Select",
"OPTIONS": [
"All",
"Folder Album Page",
"Folder",
"Album",
"Page",
"System Album"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortMethod",
"Required": false,
"ReadOnly": false,
"Default": "Organizer",
"Type": "Select",
"OPTIONS": [
"DateAdded",
"DateModified",
"Name",
"Organizer"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "SortDirection",
"Required": false,
"ReadOnly": false,
"Default": "Ascending",
"Type": "Select",
"OPTIONS": [
"Ascending",
"Descending"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
}
]
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
],
"Notes": [
"_multiargs does not work at this endpoint"
],
"Path": [
{
"type": "path",
"text": "api"
},
{
"type": "path",
"text": "v2"
},
{
"type": "path",
"text": "node"
},
{
"type": "singleparam",
"param_name": "nodeid",
"param_value": "6sjzJx",
"param_validator": {}
},
{
"type": "action",
"text": "children"
}
]
},
"Response": {
"Uri": "/api/v2/node/6sjzJx!children?start=1&count=10",
"Locator": "Node",
"LocatorType": "Objects",
"Node": [
{
"Description": "",
"Name": "Videos",
"Keywords": [],
"PasswordHint": "",
"SecurityType": "None",
"ShowCoverImage": false,
"SortDirection": "Descending",
"SortMethod": "DateModified",
"Type": "Album",
"UrlName": "Videos",
"DateAdded": "2009-04-09T13:37:06+00:00",
"DateModified": "2009-04-09T13:49:38+00:00",
"EffectiveSecurityType": "None",
"FormattedValues": {
"Name": {
"html": "Videos"
},
"Description": {
"html": "",
"text": ""
}
},
"HasChildren": false,
"IsRoot": false,
"NodeID": "tszQhH",
"SortIndex": 35,
"UrlPath": "/Videos/Videos",
"Uri": "/api/v2/node/tszQhH",
"WebUri": "https://album.seafairpirates.org/Videos/Videos",
"UriDescription": "Node with the given id.",
"Uris": {
"Album": {
"Uri": "/api/v2/album/nGX64V",
"Locator": "Album",
"LocatorType": "Object",
"UriDescription": "Album by key",
"EndpointType": "Album"
},
"ParentNode": {
"Uri": "/api/v2/node/tszQhH!parent",
"Locator": "Node",
"LocatorType": "Object",
"UriDescription": "Parent node of the given node.",
"EndpointType": "ParentNode"
},
"ParentNodes": {
"Uri": "/api/v2/node/tszQhH!parents",
"Locator": "Node",
"LocatorType": "Objects",
"UriDescription": "Hierarchy of nodes from the given node (inclusive) to the root node.",
"EndpointType": "ParentNodes"
},
"User": {
"Uri": "/api/v2/user/piratepics",
"Locator": "User",
"LocatorType": "Object",
"UriDescription": "User By Nickname",
"EndpointType": "User"
},
"NodeCoverImage": {
"Uri": "/api/v2/node/tszQhH!cover",
"Locator": "Image",
"LocatorType": "Object",
"UriDescription": "Cover image for a folder, album, or page",
"EndpointType": "NodeCoverImage"
},
"HighlightImage": {
"Uri": "/api/v2/highlight/node/tszQhH",
"Locator": "Image",
"LocatorType": "Object",
"UriDescription": "Highlight image for a folder, album, or page",
"EndpointType": "HighlightImage"
},
"NodeComments": {
"Uri": "/api/v2/node/tszQhH!comments",
"Locator": "Comment",
"LocatorType": "Objects",
"UriDescription": "Comments on a Node",
"EndpointType": "NodeComments"
},
"NodePricelist": {
"Uri": "/api/v2/node/tszQhH!pricelist",
"Locator": "NodePricelist",
"LocatorType": "Object",
"UriDescription": "Get, update, or remove the pricelist mapped to this node.",
"EndpointType": "NodePricelist"
}
},
"ResponseLevel": "Public"
}
],
"UriDescription": "Child nodes of the given node.",
"EndpointType": "ChildNodes",
"Pages": {
"Total": 1,
"Start": 1,
"Count": 1,
"RequestedCount": 10,
"FirstPage": "/api/v2/node/6sjzJx!children?start=1&count=10",
"LastPage": "/api/v2/node/6sjzJx!children?start=1&count=10"
},
"Timing": {
"Total": {
"time": 0.03873,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}