Get Sites per User¶
Get Crafter Studio sites available to a user given a username with an optional range for pagination.
Resource Information¶
HTTP Verb
|
GET
|
URL
|
/api/1/services/api/1/site/get-per-user.json |
Response Formats
|
JSON |
Required Role
|
Admin, self
|
Parameters¶
Name
|
Type
|
Required
|
Description
|
---|---|---|---|
username
|
String
|
✓
|
User for whom to find permitted sites
|
start
|
Integer
|
Start offset
|
|
number
|
Integer
|
Number of records to retrieve
|
Example¶
GET .../api/1/services/api/1/site/get-per-user.json?username=jane.doe
1 2 3 4 5 6 7 8 9 10 11 12 13 14 | {
"total": 2
"sites" :
[
{
"site_id" : "my-site1",
"description" : "My nice site 1."
},
{
"site_id" : "my-site2",
"description" : "My nice site 2."
}
]
}
|
Response¶
Status
|
Location
|
Response Body
|
---|---|---|
200
|
.../site/get-per-user.json?username=.. |
See example above.
|
400
|
{ "message" : "Invalid parameter(s)" } |
|
401
|
{ "message" : "Unauthorized" } |
|
404
|
{ "message" : "User not found"} |
|
500
|
{ "message" : "Internal server error" } |