POST | /api/configuration/getclientconfiguration |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
APIKey | body | string | No | |
ConnectorName | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientConfigurationElements | form | List<ClientConfigurationElement> | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
UiErrorMessage | form | string | No | |
UiDevErrorMessage | form | string | No | |
ErrorOccured | form | bool | No | |
LogMessageType | form | ErrorMessageType | No | |
ResponseStatus | form | ResponseStatus | No | |
NumberOfRecordsEffected | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Id | form | int | No | |
KeyName | form | string | No | |
KeyID | form | string | No | |
KeyValue | form | string | No | |
IsEncrypted | form | bool | No | |
LastUpdatedDate | form | DateTime | No | |
OrganizationID | form | int | No |
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /json/reply/ClientGetConfigurationRequest HTTP/1.1
Host: api.sampson.sagecpc.com
Content-Type: application/json
Content-Length: length
{"apiKey":"String","connectorName":"String"}
HTTP/1.1 200 OK Content-Type: application/json Content-Length: length {"clientConfigurationElements":[{"id":0,"keyName":"String","keyID":"String","keyValue":"String","isEncrypted":false,"lastUpdatedDate":"\/Date(-62135596800000-0000)\/","organizationID":0}],"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}