RAPP.Christies.ScvSyncSS

<back to all web services

UserPreferencesRequest

The following routes are available for this service:
All Verbs/userpreferences
UserPreferencesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<UserPreference>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
ErrorCodesformList<ErrorCode>No
SuccessformboolNo
ResponseStatusformResponseStatusNo
ErrorCode Parameters:
NameParameterData TypeRequiredDescription
CodeformintNo
UserPreference Parameters:
NameParameterData TypeRequiredDescription
UserIdformintNo
DisplayNameformstringNo
PrefOnlineOnlyformboolNo
PrefLocationTotalformintNo
PrefEmailformboolNo
PrefServiceTotalformintNo
PrefCommunicationTotalformintNo
PrefLiteratureTotalformintNo
MaintenanceDateformDateTimeNo
MaintenanceSourceformstringNo

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 /userpreferences HTTP/1.1 
Host: christiesscvreaderuat-ws.rapp-customers.co.uk 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

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

{
	Result: 
	[
		{
			UserId: 0,
			DisplayName: String,
			PrefOnlineOnly: False,
			PrefLocationTotal: 0,
			PrefEmail: False,
			PrefServiceTotal: 0,
			PrefCommunicationTotal: 0,
			PrefLiteratureTotal: 0,
			MaintenanceDate: 0001-01-01,
			MaintenanceSource: String
		}
	],
	ErrorCodes: 
	[
		{
			Code: 0
		}
	],
	Success: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}