MbraddressService

Manage member address records.

Symitar eDocs References: Coming soon.

Operations

getMbrAddress

post

Retrieves a member address.

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

Successful operation.

application/json
post
/getMbrAddress
200

Successful operation.

getMbrAddressSelectFields

post

Retrieves a member address with selected fields.

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

Successful operation.

application/json
post
/getMbrAddressSelectFields
200

Successful operation.

getMbrAddressSelectFieldsFilterChildren

post

Retrieves a member address with selected fields and filtered children.

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

Successful operation.

application/json
post
/getMbrAddressSelectFieldsFilterChildren
200

Successful operation.

getMbrAddressFmHistoryPagedList

post

Retrieves a paged list of member addresses from history.

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

Successful operation.

application/json
post
/getMbrAddressFmHistoryPagedList
200

Successful operation.

getMbrAddressFmHistoryListSelectFields

post

Retrieves a list of member addresses with selected fields from history.

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

Successful operation.

application/json
post
/getMbrAddressFmHistoryListSelectFields
200

Successful operation.

searchMbrAddressFmHistorySelectFields

post

Searches member addresses from history with selected fields.

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

Successful operation.

application/json
post
/searchMbrAddressFmHistorySelectFields
200

Successful operation.

getMbrAddressFmHistoryPagedListSelectFields

post

Retrieves a paged list of member addresses with selected fields from history.

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

Successful operation.

application/json
post
/getMbrAddressFmHistoryPagedListSelectFields
200

Successful operation.

searchMbrAddressFmHistoryPagedSelectFields

post

Searches member addresses from history with pagination and selected fields.

Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Body
MbrAddressMbrAddrNumberstringOptional
QuerystringOptional

Sample data for Query

Responses
200

Successful operation.

application/json
post
/searchMbrAddressFmHistoryPagedSelectFields
200

Successful operation.

updateMbrAddressByID

post

Updates a member address by its ID.

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

Successful operation.

application/json
post
/updateMbrAddressByID
200

Successful operation.

createMbrAddress

post

Creates a member address.

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

Successful operation.

application/json
post
/createMbrAddress
200

Successful operation.

Last updated

Was this helpful?