Difference between revisions of "REST API:companyInfo Resource"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
Line 48: | Line 48: | ||
</generated_classes_package_name> | </generated_classes_package_name> | ||
<supported_languages>es,en</supported_languages> | <supported_languages>es,en</supported_languages> | ||
<social_enabled>true</social_enabled> | |||
<social_feed_retention_days>365</social_feed_retention_days> | |||
</companyInfo> | </companyInfo> | ||
Line 86: | Line 88: | ||
<signature_algorithm>RSA</signature_algorithm> | <signature_algorithm>RSA</signature_algorithm> | ||
<supported_languages>es,en</supported_languages> | <supported_languages>es,en</supported_languages> | ||
<social_enabled>true</social_enabled> | |||
<social_feed_retention_days>365</social_feed_retention_days> | |||
</companyInfo> | </companyInfo> | ||
</platform> | </platform> |
Revision as of 21:43, 11 July 2011
- Considerations
-
- Use the language codes listed in Supported Languages
- (Language codes comply with the ISO 639-1 language codes standard.)
- Use the ttdate_format specified in Long Date Format
- Use the time_zone described in Time Zone Codes
Access Permissions
Users that have the Access Control/User Management permission can use the companyInfo Resource.
Get CompanyInfo
Retrieve details for a company.
- Method
- GET
- URI
- https://{domain}/networking/rest/companyInfo
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<companyInfo>
<id>1325580066</id>
<name>BobSmithCo</name>
<street>123 Maple Ave</street>
<city>Seatle</city>
<state>WA</state>
<zip>85495</zip>
<country>United States</country>
<date_created>2010-11-12T13:14:15Z</date_created>
<modified_id type=""
uri="https://{domainname}/networking/rest/user/1424089492"
displayValue="Peter Parker">1424089492</modified_id>
<date_modified>2010-11-12T13:14:15Z</date_modified>
<language>en</language>
<company_logo type="DOCUMENT" uri=
"https://{domain}/networking/rest/record/DOCUMENT/51f6bcedde6341ecb7d910643cf0ce77"
displayValue="bugs1">51f6bcedde6341ecb7d910643cf0ce77</company_logo>
<date_format>MM/dd/yyyy</date_format>
<currency_format>$</currency_format>
<copy_support_emails_to/>
<copy_import_emails_to/>
<time_zone>23</time_zone>
<starting_app_id>4</starting_app_id>
<versioning_enabled>false</versioning_enabled>
<enabled_all_record_access_log>true</enabled_all_record_access_log>
<enabled_all_access_violations_log>true</enabled_all_access_violations_log>
<signature_algorithm>RSA</signature_algorithm>
<namespace>space1</namespace>
<generated_classes_package_name>com.platform.space1.generatedobjectclasses
</generated_classes_package_name>
<supported_languages>es,en</supported_languages>
<social_enabled>true</social_enabled>
<social_feed_retention_days>365</social_feed_retention_days>
</companyInfo>
<message>
0
<description>Success</description>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Update CompanyInfo
Updates Company information.
- Method
- PUT
- URI
- https://{domain}/networking/rest/companyInfo
- Request
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<companyInfo> <name>BobSmithCo</name> <street>123 Maple Ave</street> <city>Seatle</city> <state>WA</state> <zip>85495</zip> <country>United States</country> <language>en</language> <company_logo>51f6bcedde6341ecb7d910643cf0ce77</company_logo> <date_format>MM/dd/yyyy</date_format> <currency_format>$</currency_format> <copy_support_emails_to>12312,123SA12,34R3S23121</copy_support_emails_to> <copy_import_emails_to>12312,5633S32,123DFWD232SWD</copy_import_emails_to> <time_zone>23</time_zone> <starting_app_id>4</starting_app_id> <versioning_enabled>false</versioning_enabled> <enabled_all_record_access_log>true</enabled_all_record_access_log> <enabled_all_access_violations_log>true</enabled_all_access_violations_log> <signature_algorithm>RSA</signature_algorithm> <supported_languages>es,en</supported_languages> <social_enabled>true</social_enabled> <social_feed_retention_days>365</social_feed_retention_days> </companyInfo>
</platform> </syntaxhighlight>
- Response
- <syntaxhighlight lang="xml" enclose="div">
<platform>
<message>
0
<description>Success</description>
</message>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Fields
Name Type Attribute Required During Add Description Additional Information id String Read Only Record Identifier name String Editable on Add/Update Company Name street String Editable on Add/Update city String Editable on Add/Update state String Editable on Add/Update zip String Editable on Add/Update country String Editable on Add/Update language String Editable on Add/Update Default language for new users Any two letter language code (e.g. - 'en', 'es','hi') that is available to the tenant company_logo Lookup Editable on Add/Update Document object recordId Retrieve from the Document object using the record Resource date_format String Editable on Add/Update Date_Format currency_format String Editable on Add/Update copy_support_emails_to String Editable on Add/Update Comma-separated list of email addresses to receive copies of support-related communications users copy_import_emails_to String Editable on Add/Update Comma-separated list of email addresses to receive copies of import status notifications time_zone Integer Editable on Add/Update Time Zone Codes starting_app_id Integer Editable on Add/Update ID of default application for new users Application ID must exist in the tenant space. versioning_enabled Boolean Editable on Add/Update Whether or not Versioning is enabled enabled_all_record_access_log Boolean Editable on Add/Update Whether or not Record Access activity is logged enabled_all_access_violations_log Boolean Editable on Add/Update Whether or not Access Violations are logged LastColNotes signature_algorithm String Editable on Add/Update Algorithm used to generate keys 'DSA' and 'RSA' are the only permitted values supported_languages String Editable on Add/Update Comma-separated list of supported languages Example: "en","tr","zh","hi","es","pt" date_created Date Read Only UTC Format date_modified Date Read Only UTC Format modified_id Lookup Read Only User ID