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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<UserPreferencesRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RAPP.Christies.ScvSyncSS.ServiceModel" />
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UserPreferencesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/RAPP.Christies.ScvSyncSS.ServiceModel">
  <ErrorCodes xmlns="http://schemas.datacontract.org/2004/07/RAPP.Scv.ScvDataSyncService">
    <ErrorCode>
      <Code>0</Code>
    </ErrorCode>
  </ErrorCodes>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/RAPP.Scv.ScvDataSyncService">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Success xmlns="http://schemas.datacontract.org/2004/07/RAPP.Scv.ScvDataSyncService">false</Success>
  <Result xmlns:d2p1="http://schemas.datacontract.org/2004/07/RAPP.Christies.ScvSyncSS.ServiceModel.Types">
    <d2p1:UserPreference>
      <d2p1:DisplayName>String</d2p1:DisplayName>
      <d2p1:MaintenanceDate>0001-01-01T00:00:00</d2p1:MaintenanceDate>
      <d2p1:MaintenanceSource>String</d2p1:MaintenanceSource>
      <d2p1:PrefCommunicationTotal>0</d2p1:PrefCommunicationTotal>
      <d2p1:PrefEmail>false</d2p1:PrefEmail>
      <d2p1:PrefLiteratureTotal>0</d2p1:PrefLiteratureTotal>
      <d2p1:PrefLocationTotal>0</d2p1:PrefLocationTotal>
      <d2p1:PrefOnlineOnly>false</d2p1:PrefOnlineOnly>
      <d2p1:PrefServiceTotal>0</d2p1:PrefServiceTotal>
      <d2p1:UserId>0</d2p1:UserId>
    </d2p1:UserPreference>
  </Result>
</UserPreferencesResponse>