StratusVue API Services Internal

<back to all web services

ClientSaveConfigurationRequest

Save Client Configuration Elements

The following routes are available for this service:
POST/api/configuration/saveclientconfiguration
ClientSaveConfigurationRequest Parameters:
NameParameterData TypeRequiredDescription
APIKeybodystringNo
ConnectorNamebodystringNo
ConfigurationElementsbodyList<ClientConfigurationElement>No
BaseRequest Parameters:
NameParameterData TypeRequiredDescription
AuthSessionKeyformstringNo
AdditionalInfoformList<ItemNameValue>No
ItemNameValue Parameters:
NameParameterData TypeRequiredDescription
PropertyNameformstringNo
PropertyValueformstringNo
ClientConfigurationElement Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
KeyNameformstringNo
KeyIDformstringNo
KeyValueformstringNo
IsEncryptedformboolNo
LastUpdatedDateformDateTimeNo
OrganizationIDformintNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
UiErrorMessageformstringNo
UiDevErrorMessageformstringNo
ErrorOccuredformboolNo
LogMessageTypeformErrorMessageTypeNo
ResponseStatusformResponseStatusNo
NumberOfRecordsEffectedformintNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /json/reply/ClientSaveConfigurationRequest HTTP/1.1 
Host: api.sampson.sagecpc.com 
Content-Type: application/json
Content-Length: length

{"apiKey":"String","connectorName":"String","configurationElements":[{"id":0,"keyName":"String","keyID":"String","keyValue":"String","isEncrypted":false,"lastUpdatedDate":"\/Date(-62135596800000-0000)\/","organizationID":0}],"authSessionKey":"String","additionalInfo":[{"propertyName":"String","propertyValue":"String"}]}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"uiErrorMessage":"String","uiDevErrorMessage":"String","errorOccured":false,"logMessageType":"DEBUG","responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}},"numberOfRecordsEffected":0}