Response [200 Ok]
| Uri | /api/v2/user |
|---|---|
| UriDescription | Base URI for user-related operations |
| DocUri | https://api.smugmug.com/api/v2/doc/reference/user.html |
| EndpointType | UserBase |
Uris
RootNode
/api/v2/user/:nickname!rootnode
| Uri | /api/v2/user/:nickname!rootnode |
|---|---|
| UriDescription | User Root Node |
| EndpointType | RootNode |
| Locator | RootNode |
| LocatorType | Object |
User
/api/v2/user/:nickname
| Uri | /api/v2/user/:nickname |
|---|---|
| UriDescription | User By Nickname |
| EndpointType | User |
| Locator | User |
| LocatorType | Object |
UserSearch
/api/v2/user!search
| Uri | /api/v2/user!search |
|---|---|
| UriDescription | Search for user |
| EndpointType | UserSearch |
| Locator | User |
| LocatorType | Objects |
Request
| Uri | /api/v2/user?_accept=text%2Fhtml |
|---|---|
| Method | GET |
| Version | v2 |
Config
{
"expand_method": "ref",
"shorturis": false
}
Options
Methods
OPTIONS
| Permissions |
|
|---|
GET
| Permissions |
|
|---|
POST
| Permissions |
|
|---|
JSON
{
"Request": {
"Version": "v2",
"Method": "GET",
"Uri": "/api/v2/user?_accept=text%2Fhtml"
},
"Options": {
"MethodDetails": {
"OPTIONS": {
"Permissions": [
"Read"
]
},
"GET": {
"Permissions": [
"Read"
]
},
"POST": {
"Permissions": [
"Add"
]
}
},
"Methods": [
"OPTIONS",
"GET",
"POST"
],
"ParameterDescription": {
"Varchar": "Variable length text from MIN_CHARS to MAX_CHARS (MAX_CHARS = INFINITY meaning arbitrary length)",
"Uri": "Absolute or relative URL, restricted to Locator(s) of the supplied URL if not null. Up to a MAX_LENGTH in length.",
"Select": "Select one option. Options should pass only the \"Value\".",
"TimeZone": "Date time zone"
},
"Parameters": {
"POST": [
{
"Name": "Email",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 100
},
{
"Name": "FirstName",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "LastName",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
},
{
"Name": "NickName",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 35
},
{
"Name": "Password",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 100
},
{
"Name": "PlanUri",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Uri",
"MAX_LENGTH": "INFINITY",
"Locator": [
"Plan"
]
},
{
"Name": "IntentToSell",
"Required": true,
"ReadOnly": false,
"Default": null,
"Type": "Select",
"OPTIONS": [
"yes",
"no",
"maybe",
"skipped"
],
"MIN_COUNT": 1,
"MAX_COUNT": 1
},
{
"Name": "TimeZone",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "TimeZone"
},
{
"Name": "Ureferrer",
"Required": false,
"ReadOnly": false,
"Default": null,
"Type": "Varchar",
"MIN_CHARS": 0,
"MAX_CHARS": 50
}
]
},
"MediaTypes": [
"application/json",
"application/vnd.php.serialized",
"application/x-msgpack",
"text/html",
"text/csv"
]
},
"Response": {
"Uri": "/api/v2/user",
"Uris": {
"User": {
"Uri": "/api/v2/user/:nickname",
"Locator": "User",
"LocatorType": "Object",
"UriDescription": "User By Nickname",
"EndpointType": "User"
},
"RootNode": {
"Uri": "/api/v2/user/:nickname!rootnode",
"Locator": "RootNode",
"LocatorType": "Object",
"UriDescription": "User Root Node",
"EndpointType": "RootNode"
},
"UserSearch": {
"Uri": "/api/v2/user!search",
"Locator": "User",
"LocatorType": "Objects",
"UriDescription": "Search for user",
"EndpointType": "UserSearch"
}
},
"UriDescription": "Base URI for user-related operations",
"EndpointType": "UserBase",
"DocUri": "https://api.smugmug.com/api/v2/doc/reference/user.html",
"Timing": {
"Total": {
"time": 0.02323,
"cycles": 1,
"objects": 0
}
}
},
"Code": 200,
"Message": "Ok"
}