Preference

Perform various operations on preference records.

Symitar eDocs References: Coming soon.

Operations

getPreferenceSelectFields

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getPreferenceSelectFields
200

Successful operation.

getPreferenceSelectFieldsFilterChildren

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getPreferenceSelectFieldsFilterChildren
200

Successful operation.

getPreferencePagedListSelectFields

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/getPreferencePagedListSelectFields
200

Successful operation.

searchPreferencePagedSelectFields

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/searchPreferencePagedSelectFields
200

Successful operation.

getPreferenceAccessSelectFields

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
PreferenceAccessLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getPreferenceAccessSelectFields
200

Successful operation.

getPreferenceAccessPagedListSelectFields

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/getPreferenceAccessPagedListSelectFields
200

Successful operation.

searchPreferenceAccessPagedSelectFields

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/searchPreferenceAccessPagedSelectFields
200

Successful operation.

updatePreferenceByID

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/updatePreferenceByID
200

Successful operation.

updatePreferenceAccessByID

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
PreferenceAccessLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/updatePreferenceAccessByID
200

Successful operation.

createPreference

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
Responses
200

Successful operation.

application/json
post
/createPreference
200

Successful operation.

createPreferenceAccess

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/createPreferenceAccess
200

Successful operation.

deletePreference

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deletePreference
200

Successful operation.

deletePreferenceAccess

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
AccountNumberstringOptional
PreferenceLocatorintegerOptional
PreferenceAccessLocatorintegerOptional
Responses
200

Successful operation.

application/json
post
/deletePreferenceAccess
200

Successful operation.

Last updated

Was this helpful?