User.profiles: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
(Created page with 'Returns the list of a user's registration profiles = Info = * '''Component name:''' user.profiles * '''Signature:''' Requires signature using the authkey's private key * '''Time…')
 
m (5 revisions imported)
 
(4 intermediate revisions by one other user not shown)
Line 6: Line 6:
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Authorization level:''' GET
* '''Authorization level:''' GET
* '''API trust level''': Standard


= Parameters =  
= Parameters =  
Line 19: Line 20:
*** '''name''': Profile name
*** '''name''': Profile name


= Sample =
= Example =
REQUEST:
REQUEST:


  <nowiki>https://api.safecreative.org/v2/</nowiki>
  <nowiki>https://api.safecreative.org/v2/</nowiki>
  ?component=user.profiles
  ?'''component'''=user.profiles
  &authkey=1i5g2aaf2bz09lyo867cuimqg
  &'''authkey'''=1i5g2aaf2bz09lyo867cuimqg
  &ztime=1271749846810
  &'''ztime'''=1271749846810
  &signature=81acc424b19596af6b4471146ec373fcc6aa7b26
  &'''signature'''=81acc424b19596af6b4471146ec373fcc6aa7b26


RESPONSE:
RESPONSE:


<?xml version="1.0" encoding="UTF-8"?>
<pre>
'''<profiles>'''
<?xml version="1.0" encoding="UTF-8"?>
   '''<profile>'''
<profiles>
     '''<nowiki><code></nowiki>'''0701034400200'''<nowiki></code></nowiki>'''
   <profile>
     '''<name>'''Blog'''</name>'''
     <code>0701034400200</code>
   '''</profile>'''
     <name>Blog</name>
   '''<profile>'''
   </profile>
     '''<nowiki><code></nowiki>'''0702034400200'''<nowiki></code></nowiki>'''
   <profile>
     '''<name>'''Article'''</name>'''
     <code>0702034400200</code>
   '''</profile>'''
     <name>Article</name>
   '''<profile>'''
   </profile>
     '''<nowiki><code></nowiki>'''0702034400204'''<nowiki></code></nowiki>'''
   <profile>
     '''<name>'''Photo'''</name>'''
     <code>0702034400204</code>
   '''</profile>'''
     <name>Photo</name>
'''</profiles>'''
   </profile>
 
</profiles>
</pre>


[[Category:API component]]
[[Category:API component]]

Latest revision as of 08:07, 7 May 2021

Returns the list of a user's registration profiles

Info

  • Component name: user.profiles
  • Signature: Requires signature using the authkey's private key
  • Timestamp: Requires ztime parameter
  • Authorization level: GET
  • API trust level: Standard

Parameters

  • authkey*: User's authorization key
  • ztime*: Z-Timestamp

* Required parameter

Returns

  • profiles
    • profile
      • code: Profile code
      • name: Profile name

Example

REQUEST:

https://api.safecreative.org/v2/
?component=user.profiles
&authkey=1i5g2aaf2bz09lyo867cuimqg
&ztime=1271749846810
&signature=81acc424b19596af6b4471146ec373fcc6aa7b26

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<profiles>
   <profile>
     <code>0701034400200</code>
     <name>Blog</name>
   </profile>
   <profile>
     <code>0702034400200</code>
     <name>Article</name>
   </profile>
   <profile>
     <code>0702034400204</code>
     <name>Photo</name>
   </profile>
</profiles>