Preference

Perform various operations on preference records.

Symitar eDocs References: Coming soon.

Operations

getPreference

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

Successful operation.

application/json
post
/getPreference
200

Successful operation.

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.

getPreferencePagedList

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

Successful operation.

application/json
post
/getPreferencePagedList
200

Successful operation.

getPreferenceListSelectFields

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

Successful operation.

application/json
post
/getPreferenceListSelectFields
200

Successful operation.

searchPreferenceSelectFields

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

Successful operation.

application/json
post
/searchPreferenceSelectFields
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
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchPreferencePagedSelectFields
200

Successful operation.

getPreferenceAccess

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

Successful operation.

application/json
post
/getPreferenceAccess
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.

getPreferenceAccessPagedList

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

Successful operation.

application/json
post
/getPreferenceAccessPagedList
200

Successful operation.

getPreferenceAccessListSelectFields

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

Successful operation.

application/json
post
/getPreferenceAccessListSelectFields
200

Successful operation.

searchPreferenceAccessSelectFields

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

Successful operation.

application/json
post
/searchPreferenceAccessSelectFields
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
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchPreferenceAccessPagedSelectFields
200

Successful operation.

updatePreferenceByID

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

Successful operation.

application/json
post
/updatePreferenceByID
200

Successful operation.

updatePreferenceAccessByID

post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
PreferenceAccessLocatorintegerOptional
AccountNumberstringOptional
PreferenceLocatorintegerOptional
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?