Member Objects

The following operations use a RequestMember object to receive data into the API and a ResponseMember object to return data out of the API. The table below indicates the fields and properties included in each:

Field Description

RequestMember

ResponseMember

firstname First name of member account

Yes

Yes

lastname Last name of member account

Yes

Yes

email Email address of member account

Yes

Yes

company Company name of member account

Yes

Yes

address1 Address line 1 of member account

Yes

Yes

address2 Address line 2 of member account

Yes

Yes

suburb Suburb of member account

Yes

Yes

state State of member account

Yes

Yes

postcode Postal/Zip code of member account

Yes

Yes

country Country code of member account. A lookup to GetCountries can be made to get the latest name for that Country.

Yes

Yes

phone Phone number of member account

Yes

Yes

username Username of member account.

Yes

Yes

password Password of member account.

Yes

Yes

termsaccept Indicates whether the member has been flagged as accepting any terms or agreements by showing “true” or “false”.

Yes

Yes

subscribe Indicates whether the member has been flagged as subscribing to a list for future communication/marketing.

Yes

Yes

fileformat The preferred/default file format when downloading tracks.(See getserviceinfo)

Yes

Yes

searchformat The preferred/default arrangement view for search results. The only available option in this version of the API is “TrackTrack – will return results listed as individual tracks.

Yes

Yes

searchsort The preferred/default sorting view for search results. The available options are “Fav”, “New” and “Alph”. Fav– will return results sorted by the member’s specified ordering of Libraries. If this feature is not available to the user then the results will be sorted alphabetically. New– will return results sorted by the date the tracks were added to the API, with most recent at the top. Alph – will return results sorted alphabetically by track title.

Yes

Yes

nomemberemail Determines if the welcome email is sent to the registered address or not. Default is false, set true to disable the welcome email. Yes Yes
sampleenabled Indicates whether the member has been granted permission to receive the streaming files for the tracks by showing “true” or “false”.

No

Yes

downloadenabled Indicates whether the member has been granted permission to download high quality media files for the tracks by showing “true” or “false”.

No

Yes

downloadsremaining This element will show either “null”, depicting that the member account has an unlimited amount of downloads available, or an integer value greater than or equal to zero (0). That integer value indicates the total number of track downloads available to the member account. Each track in an album or playlist will count as a single download. For example, a member account will need at least 20 downloads remaining to download a full album containing 20 tracks

No

Yes

status The current status of the member. Possible status’ are:pending– member has registered but is yet to be approved or denied.active– member has registered and has been approved.denied – member has registered and has been denied.archived – member has been archived / deleted.

No

Yes

asseturl The member specific URLs to use when accessing media once a user has logged in and/or been authenticated. These URLs are to be used in place of the URLs provided in the GetServiceInfooperation in order to record usage against the member account.Click here a detailed description on each URLs format and use.

No

Yes

 
Was this article helpful?
0 out of 0 found this helpful
Have more questions? Submit a request

Comments

Article is closed for comments.