FrameAppWS

<back to all web services

UpdateCitizenRQ

Requires Authentication
The following routes are available for this service:
All Verbs/citizen/update
UpdateCitizenRQ Parameters:
NameParameterData TypeRequiredDescription
EmailquerystringNo
DisplayNamequerystringNo
AvatarquerystringNo
ThemequerystringNo
PhoneNumberquerystringNo
CurrentPasswordquerystringNo
PasswordquerystringNo
AuthenticateCitizenRS Parameters:
NameParameterData TypeRequiredDescription
DataformCitizenNo
CoreRS Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
ErrorMessageformstringNo
ErrorStackTraceformstringNo
Citizen Parameters:
NameParameterData TypeRequiredDescription
EmailformstringNo
DisplayNameformstringNo
AvatarformstringNo
ThemeformstringNo
PhoneNumberformstringNo
ProviderformlongNo
ProviderIdformstringNo
PasswordformstringNo
BannedformstringNo
StatusformstringNo

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 /citizen/update HTTP/1.1 
Host: ws.jimsnwa.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Email: String,
	DisplayName: String,
	Avatar: String,
	Theme: String,
	PhoneNumber: String,
	CurrentPassword: String,
	Password: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	{
		Email: String,
		DisplayName: String,
		Avatar: String,
		Theme: String,
		PhoneNumber: String,
		Provider: 0,
		ProviderId: String,
		Password: String,
		Banned: String,
		Status: String
	},
	Code: String,
	ErrorMessage: String,
	ErrorStackTrace: String
}