regis

<back to all web services

UserSettingsRequest

Requires Authentication
Required role:REGISUserRole
The following routes are available for this service:
POST/UserSettings

export class UserSettingsResponse
{
    public responseStatus: ResponseStatus;
    public settings: { [index: string]: string; };

    public constructor(init?: Partial<UserSettingsResponse>) { (Object as any).assign(this, init); }
}

export class UserSettingsRequest
{
    public uuid: string;

    public constructor(init?: Partial<UserSettingsRequest>) { (Object as any).assign(this, init); }
}

TypeScript UserSettingsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /UserSettings HTTP/1.1 
Host: data.regent-college.edu 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	uuid: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	},
	settings: 
	{
		String: String
	}
}