Portals
- Supported Roles
- Available Services
- Current User's Portal
- Portal Description
- Expansions
- API Explorer
Supported Roles
| Role |
Reads? |
Writes? |
| IDX |
Yes |
No |
| VOW |
Yes |
No |
| Private |
Yes |
Yes |
More information about roles
may be found here.
Available Services
Current User's Portal
URI: /<API Version>/portal
| HTTP Method |
Description |
Notes |
| GET |
Returns the portal information for the current user |
|
| POST |
Creates a portal |
|
| PUT |
Updates an existing portal |
|
| DELETE |
Returns HTTP 405 (Method Not Allowed) |
Not implemented |
GET Request
No parameters
GET Response
Example:
{
"D": {
"Success": true,
"Results": [{
"ResourceUri": "/v1/portal/20100912153422758914000000",
"Id": "20100912153422758914000000",
"OwnerId": "20110000000000000000000001",
"ModificationTimestamp": 2011-11-18T16:35:43,
"Name": "greatportal",
"DisplayName": "GreatPortal",
"Enabled": true,
"RequiredFields": ["Address", "Phone"]
}]
}
}
POST Request
Request Body
{
"D": {
"DisplayName": "GreatPortal",
"Enabled": true,
"RequiredFields": ["Address", "Phone"]
}
}
POST Response
The
standard success/fail response is returned.
PUT Request
Any field used in the POST request to create a portal may be used in a PUT request to update the portal.
Request Body
{
"D": {
"Enabled": false
}
}
PUT Response
The
standard success/fail response is returned.
