User Services

Use the user services to create, activate, deactivate, update and get account details on specific users in our system.

GetUserList

Description

The GetUserList method returns a list of users in your site.

Request Parameters

Field Field Type Data Type Description
Authorization Header String This is the authorization token you'll get from the site administrator console. You must send this string with every api request.
Method URL String To use this method you must use the string: GetUserList
Page URL Integer This is the page or records you want.
Count URL Integer The is the number of records per page you want returned. The maximum number of results the system will return is 1000 at a time. The default value for this field is 1000.

Example:

If you only wanted to get the first 100 users on you site then you would use the following url along with the authorization string in your header:

http://yoursite.com/webservices/user?method=GetUserList&Page=1&Count=100

Response

The response is an xml document whose root element is iRebatesResponse. Below are it's child elements.

Field Type Description
Results Integer The number of records returned on this page of results.
Page Integer The current page of records returned.
RecordsPerPage Integer The number of records per page requested
TotalRecords Integer The total number of users that are in your site. This is used to help calculate the number of requests required to get all records.
Users Node Collection Contains User nodes containing the information for each user

User Nodes

Field Type Description
UserID Integer The User's ID in the iRebates system. This can be used in other web services.
Username String The User's username.
FirstName String The User's first name.
LastName String The User's last name.
Email String The User's email.
Street String The User's street address.
Street2 String The User's street address second field.
City String The User's city.
State String The User's state.
Zip String The User's zip code.
Country String The User's country.
Phone String The User's phone number.
Organization String The User's organization.
Title String The User's title.
SignupDate Timestamp The date and time the user account was created.
TaxIDNumber String The User's Tax ID Number.
MinimumPayment Double The minimum amount of a payment the user will receive. The lowest value this can be is $10.00
ReceivePromotions Bit A value that indicates whether the user has opted to receive promotional emails.
ReceiveNewsletters Bit A value that indicates whether the user has opted to receive newsletter emails.

Example

Here is an example of a response.

<iRebatesResponse>
    <Results>1</Results>
    <Page>1</Page>
    <RecordsPerPage>1</RecordsPerPage>
    <TotalRecords>526</TotalRecords>
    <Users>
        <User>
            <UserID>646821</UserID>
            <Username>jdoe</Username>
            <FirstName>John</FirstName>
            <LastName>Doe</LastName>
            <Email>jdoe@example.com</Email>
            <Street>123 Somewhere</Street>
            <Street2/>
            <City>Winchestertonfieldville</City>
            <State>IA</State>
            <Zip>12345</Zip>
            <Country>US</Country>
            <Phone/>
            <Organization/>
            <Title/>
            <SignupDate>{ts '2008-10-08 14:51:19'}</SignupDate>
            <TaxIDNumber/>
            <MinimumPayment>25</MinimumPayment>
            <ReceivePromotions>1</ReceivePromotions>
            <ReceiveNewsletters>1</ReceiveNewsletters>
        </User>
    </Users>
</iRebatesResponse>

GetUserDetails

Description

The GetUserDetails method returns the details of a specific user on your site. You can use their UserID, Username or Email to access their account.

Request Parameters

Field Field Type Data Type Description
Authorization Header String This is the authorization token you'll get from the site administrator console. You must send this string with every api request.
Method URL String To use this method you must use the string: GetUserDetails
UserID URL Integer This is the id of the user in the iRebates system.
Username URL String This is the username of the user in the iRebates system
Email URL String This is the email address of the user in the iRebates system

Example:

If you only wanted to get the first 100 users on you site then you would use the following url along with the authorization string in your header:

http://yoursite.com/webservices/user?method=GetUserDetails&UserID=12345

Response

The response is an xml document whose root element is iRebatesResponse. If successful it will contain only one child node named User. Below are it's child elements.

Field Type Description
UserID Integer The User's ID in the iRebates system. This can be used in other web services.
Username String The User's username.
FirstName String The User's first name.
LastName String The User's last name.
Email String The User's email.
Street String The User's street address.
Street2 String The User's street address second field.
City String The User's city.
State String The User's state.
Zip String The User's zip code.
Country String The User's country.
Phone String The User's phone number.
Organization String The User's organization.
Title String The User's title.
SignupDate Timestamp The date and time the user account was created.
TaxIDNumber String The User's Tax ID Number.
MinimumPayment Double The minimum amount of a payment the user will receive. The lowest value this can be is $10.00
ReceivePromotions Bit A value that indicates whether the user has opted to receive promotional emails.
ReceiveNewsletters Bit A value that indicates whether the user has opted to receive newsletter emails.

Example

Here is an example of a response.

<iRebatesResponse>
    <User>
        <UserID>646821</UserID>
        <Username>jdoe</Username>
        <FirstName>John</FirstName>
        <LastName>Doe</LastName>
        <Email>jdoe@example.com</Email>
        <Street>123 Somewhere</Street>
        <Street2/>
        <City>Winchestertonfieldville</City>
        <State>IA</State>
        <Zip>12345</Zip>
        <Country>US</Country>
        <Phone/>
        <Organization/>
        <Title/>
        <SignupDate>{ts '2008-10-08 14:51:19'}</SignupDate>
        <TaxIDNumber/>
        <MinimumPayment>25</MinimumPayment>
        <ReceivePromotions>1</ReceivePromotions>
        <ReceiveNewsletters>1</ReceiveNewsletters>
    </User>
</iRebatesResponse>

CreateUser

Description

The CreateUser method creates a user for your site.

Request Parameters

Field Field Type Data Type Description
Authorization Header String This is the authorization token you'll get from the site administrator console. You must send this string with every api request.
Method URL String To use this method you must use the string: CreateUser
Username URL String The User's username.
Password URL String The User's password.
FirstName URL String The User's first name.
LastName URL String The User's last name.
Email URL String The User's email.
Street URL String The User's street address.
Street2 URL String The User's street address second field.
City URL String The User's city.
State URL String The User's state.
Zip URL String The User's zip code.
Country URL String The User's country.
Phone URL String The User's phone number.
Organization URL String The User's organization.
Title URL String The User's title.

Example:

If you wanted to create a use for your site then you would use the following url along with the authorization string in your header:

http://yoursite.com/webservices/user?method=CreateUser&Username=jdoe&Password=password

Response

The response is an xml document whose root element is iRebatesResponse. Below are it's child elements.

Field Type Description
UserID Integer The UserID of the new user

Example

Here is an example of a response.

<iRebatesResponse>
    <UserID>1</UserID>
</iRebatesResponse>

Our Engineers are working hard to continue the documentation for these features. Check back later for more features.