GET Roles API Version 1

Aldo Lambruschini

Modified on: Mon, 18 Jan, 2021 at 12:47 PM

GET Roles API

Updated on 2014-05-21
Current Version: Version 1
Deprecated Version: NA
Requests Allowed: GET&SOAP

Summary:

Returns an array of roles.

Resource/WSDL Page:

http://<your_domain_here>/api/1/get.asmx?op=Roles

Parameters

api_key
Required
Type: STRING
Length (Max/Min): 50

Must be a valid API key (existing and not expired)

Example Values: Fo35NRAqvFLXoZxqB4aViaiYM7iVMhh

**Note all optional parameters still need to be passed through in the actual call. These parameters do not need a value (therefore you can use a null value).

Example Request

GET	https://demo-new.cakemarketing.com/api/1/get.asmx/Roles?api_key=3YmDJeT3VHTFhDqAjr2OlQ

Sample XML Response:

<roles_response>
<success>true</success>
<row_count>120</row_count>
<roles>
<role>
<role_id>3</role_id>
<role_name>Account Manager</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>118</role_id>
<role_name>account manager 2</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>52</role_id>
<role_name>Accountant</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>101</role_id>
<role_name>accounting</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>102</role_id>
<role_name>accounting</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>59</role_id>
<role_name>Accounting</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>99</role_id>
<role_name>Accounting Dept. </role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>75</role_id>
<role_name>Add Offer Only</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>85</role_id>
<role_name>ADMIN 1</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>1</role_id>
<role_name>Administrator</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>4</role_id>
<role_name>Affiliate Manager</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>72</role_id>
<role_name>Affiliate Manager - Tom </role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>22</role_id>
<role_name>andy testtest</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>71</role_id>
<role_name>Andy's Roll</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>94</role_id>
<role_name>Bob</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>43</role_id>
<role_name>Bryan Employee</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>35</role_id>
<role_name>Call Center</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>73</role_id>
<role_name>Call Center </role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>36</role_id>
<role_name>Call Center 2</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>37</role_id>
<role_name>Call Center 3</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>38</role_id>
<role_name>Call Center 4</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>25</role_id>
<role_name>Call Center Admin</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>66</role_id>
<role_name>Campaign Minus Offer</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>65</role_id>
<role_name>CHIE - Ad Rep</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>64</role_id>
<role_name>CHIE - PUB REP</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>91</role_id>
<role_name>Creatives only</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>110</role_id>
<role_name>Credit Example</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>5</role_id>
<role_name>Customer Service</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>86</role_id>
<role_name>Darcy Test Role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>97</role_id>
<role_name>Dave Role - DO NOT TOUCH</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>123</role_id>
<role_name>Demo Project</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>48</role_id>
<role_name>DYE TEST</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>109</role_id>
<role_name>Felipe Test</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>124</role_id>
<role_name>Finance</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>78</role_id>
<role_name>Garth and Drew Day OF FUN</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>103</role_id>
<role_name>howard ST 7</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>104</role_id>
<role_name>howard ST 7.2</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>105</role_id>
<role_name>howard ST 7.3</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>106</role_id>
<role_name>howard ST 7.4</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>107</role_id>
<role_name>howard ST 7.5</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>53</role_id>
<role_name>Jena's Test Role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>80</role_id>
<role_name>Jo Test Role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>81</role_id>
<role_name>Jo's Test Role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>79</role_id>
<role_name>Jo's Test Role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>83</role_id>
<role_name>Jo's test role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>84</role_id>
<role_name>Jo's Test Role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>98</role_id>
<role_name>John the manager</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>46</role_id>
<role_name>Jr. Accounting</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>55</role_id>
<role_name>Kelly Tiger</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>62</role_id>
<role_name>LeadGen</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>45</role_id>
<role_name>Lindsey</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>111</role_id>
<role_name>Matt Test</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>100</role_id>
<role_name>Matt Test</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>112</role_id>
<role_name>Matt Test 2</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>92</role_id>
<role_name>Mines~</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>67</role_id>
<role_name>Nada</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>90</role_id>
<role_name>New AFfiliate</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>87</role_id>
<role_name>New Employee</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>88</role_id>
<role_name>New Employee</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>42</role_id>
<role_name>Partner #1</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>47</role_id>
<role_name>Reporting</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>77</role_id>
<role_name>Reporting person</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>24</role_id>
<role_name>Reports and Scrub</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>95</role_id>
<role_name>Role X</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>119</role_id>
<role_name>Rons Permissions</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>23</role_id>
<role_name>Sales Agent</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>51</role_id>
<role_name>Senior Account Manager</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>58</role_id>
<role_name>Super Affiliate Manager</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>50</role_id>
<role_name>test</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>114</role_id>
<role_name>test</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>117</role_id>
<role_name>test</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>63</role_id>
<role_name>TEST account</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>60</role_id>
<role_name>Test Buyer</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>61</role_id>
<role_name>TEST buyer</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>12</role_id>
<role_name>test employee role</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>20</role_id>
<role_name>test for dave</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>17</role_id>
<role_name>test pop 2</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>16</role_id>
<role_name>test popup 1</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>76</role_id>
<role_name>test Unique IDs</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>93</role_id>
<role_name>Test111111</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>57</role_id>
<role_name>test123</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>68</role_id>
<role_name>test123</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>69</role_id>
<role_name>test456</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>70</role_id>
<role_name>test777</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>89</role_id>
<role_name>Tester</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>31</role_id>
<role_name>Traffic Manager </role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>32</role_id>
<role_name>Traffic Manager </role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>33</role_id>
<role_name>Traffic Manager </role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>34</role_id>
<role_name>Traffic Manager </role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>74</role_id>
<role_name>UK Affiliate Manager</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>39</role_id>
<role_name>UK manager</role_name>
<entity_type_id xsi:nil="true"/>
<entity_type_name>Employee</entity_type_name>
</role>
<role>
<role_id>6</role_id>
<role_name>Affiliate</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>120</role_id>
<role_name>Affiliate 2 Test Role</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>82</role_id>
<role_name>Jo's Test Affiliate</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>116</role_id>
<role_name>new 12.26.13</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>121</role_id>
<role_name>Pull Links Only</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>113</role_id>
<role_name>Super Test </role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>108</role_id>
<role_name>test</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>9</role_id>
<role_name>test affiliate role</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>10</role_id>
<role_name>test affiliate role</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>44</role_id>
<role_name>testy</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>122</role_id>
<role_name>things</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>54</role_id>
<role_name>Tim Shaffer </role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>56</role_id>
<role_name>Tommy Cloud</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>41</role_id>
<role_name>traffic mngr</role_name>
<entity_type_id>1</entity_type_id>
<entity_type_name>Affiliate</entity_type_name>
</role>
<role>
<role_id>2</role_id>
<role_name>Buyer</role_name>
<entity_type_id>2</entity_type_id>
<entity_type_name>Buyer</entity_type_name>
</role>
<role>
<role_id>115</role_id>
<role_name>gfg</role_name>
<entity_type_id>2</entity_type_id>
<entity_type_name>Buyer</entity_type_name>
</role>
<role>
<role_id>11</role_id>
<role_name>test buyer role</role_name>
<entity_type_id>2</entity_type_id>
<entity_type_name>Buyer</entity_type_name>
</role>
<role>
<role_id>19</role_id>
<role_name>test pop 4</role_name>
<entity_type_id>2</entity_type_id>
<entity_type_name>Buyer</entity_type_name>
</role>
<role>
<role_id>7</role_id>
<role_name>Advertiser</role_name>
<entity_type_id>3</entity_type_id>
<entity_type_name>Advertiser</entity_type_name>
</role>
<role>
<role_id>96</role_id>
<role_name>eHow</role_name>
<entity_type_id>3</entity_type_id>
<entity_type_name>Advertiser</entity_type_name>
</role>
<role>
<role_id>13</role_id>
<role_name>test advertiser role</role_name>
<entity_type_id>3</entity_type_id>
<entity_type_name>Advertiser</entity_type_name>
</role>
<role>
<role_id>14</role_id>
<role_name>test advertiser role</role_name>
<entity_type_id>3</entity_type_id>
<entity_type_name>Advertiser</entity_type_name>
</role>
<role>
<role_id>8</role_id>
<role_name>List Manager</role_name>
<entity_type_id>4</entity_type_id>
<entity_type_name>List Manager</entity_type_name>
</role>
<role>
<role_id>21</role_id>
<role_name>test list manager role</role_name>
<entity_type_id>4</entity_type_id>
<entity_type_name>List Manager</entity_type_name>
</role>
<role>
<role_id>18</role_id>
<role_name>test pop 3</role_name>
<entity_type_id>4</entity_type_id>
<entity_type_name>List Manager</entity_type_name>
</role>
<role>
<role_id>15</role_id>
<role_name>test pop up role</role_name>
<entity_type_id>4</entity_type_id>
<entity_type_name>List Manager</entity_type_name>
</role>
<role>
<role_id>40</role_id>
<role_name>Billing</role_name>
<entity_type_id>10</entity_type_id>
<entity_type_name>Contact</entity_type_name>
</role>
<role>
<role_id>30</role_id>
<role_name>Call Center</role_name>
<entity_type_id>10</entity_type_id>
<entity_type_name>Contact</entity_type_name>
</role
<role>
<role_id>49</role_id>
<role_name>Test Role</role_name>
<entity_type_id>10</entity_type_id>
<entity_type_name>Contact</entity_type_name>
</role>
</roles>
</roles_response>

Example Error Messages:

Error Message	Likely Cause
Invalid API Key	API key does not exist or is expired