REST API:utility Resource
From AgileApps Support Wiki
Revision as of 21:03, 30 March 2012 by imported>Aeric (Text replace - '<tt><nowiki>https://{domain}/networking' to '<tt>{{platformURL}}')
Utilities available through the REST API.
Time Zone Utilities
Retrieve the List of Time Zone Codes
- Description
- Retrieves the List of Time Zone Codes
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/utility/timeZone</nowiki>
- Response
<syntaxhighlight lang="xml" enclose="div"> <platform>
<timeZone> <id>80</id> <javaValue>Pacific/Kiritimati</javaValue> <user_fiendly_value>(GMT+14:00) Line Is. Time (Pacific/Kiritimati)</user_fiendly_value> </timeZone>
<timeZone> <id>76</id> <javaValue>Pacific/Enderbury</javaValue> <userFriendlyValue>(GMT+13:00) Phoenix Is. Time (Pacific/Enderbury)</userFriendlyValue> </timeZone>
<timeZone> <id>84</id> <javaValue>Pacific/Tongatapu</javaValue> <userFriendlyValue>(GMT+13:00) Tonga Time (Pacific/Tongatapu)</userFriendlyValue> </timeZone>
<message>
0
<description>Success</description>
</message>
<recordCount>3</recordCount>
</platform> </syntaxhighlight>
- See also: REST API:Error Codes
Retrieve Time Zone Codes for a Specified Time Zone ID
- Description
- Retrieve time zones given time zone ID
- Method
- GET
- URI
- https://{yourDomain}/networking/rest/utility/timeZone/{id}</nowiki>
- Response
<syntaxhighlight lang="xml" enclose="div"> <platform>
<timeZone> <id>80</id> <javaValue>Pacific/Kiritimati</javaValue> <userFriendlyValue>(GMT+14:00) Line Is. Time (Pacific/Kiritimati)</userFriendlyValue> </timeZone>
<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 Timezone ID Learn more: Time Zone Codes javaValue String Read Only Time zone java value userFriendlyValue String Read Only Time zone user friendly value