Symbol Web Services
The following web service functions related to symbols are available in Longview:
Assign Parent
The Assign Parent function sends a request to assign existing symbols to existing parents in the Longview system. The request to assign parent-child relationships is similar to the following example:
V7 Request |
<sym:assignParentRequest> <!--1 or more repetitions:--> <web:assignParent priority="1"> <web:dimension>Accounts</web:dimension> <web:child>41010</web:child> <web:parent>Test</web:parent> <web:weight>+</web:weight> </web:assignParent> <web:assignParent priority="2"> <web:dimension>Accounts</web:dimension> <web:child>41200</web:child> <web:parent>Test</web:parent> <web:weight>+</web:weight> </web:assignParent> </sym:assignParentRequest> |
Element.Attribute | Value | Notes |
|---|---|---|
Priority | An integer |
|
Dimension | A dimension name |
|
Child | A child symbol name |
|
Parent | A parent symbol name |
|
Weight | +, -, or 0 | The default value is 0. |
The response from the Data Server is similar to the following example:
V7 Response |
<_:assignParentResponse xmlns:_="http://longview.com/dataservices/ WebServices/Symbol" xmlns="http://longview.com/dataservices" xmlns:tns="http:// longview.com/dataservices/webServiceObject" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <_:assignParentResult> <tns:type>Success</tns:type> <tns:code>0</tns:code> </_:assignParentResult> </_:assignParentResponse> |
Create
The Create function sends a request to create new symbols in the Longview system.
The request to create symbols is similar to the following example:
V7 Request |
<sym:createRequest> <!--1 or more repetitions:--> <web:symbol> <web:dimension>Accounts</web:dimension> <web:symbolInfo virtual="false" receiveRollups="true"> <web:name>Test</web:name> <!--Optional:--> <web:type>Standard</web:type> <!--Optional:--> <web:balanceType>Debit</web:balanceType> <!--Optional:--> <web:sortChildren>Manual</web:sortChildren> <!--0 to 2 repetitions:--> <web:description> <web:language>en</web:language> <web:description>Test Symbol</web:description> </web:description> </web:symbolInfo> </web:symbol> </sym:createRequest> |
Element.Attribute | Value | Notes |
|---|---|---|
Dimension | The name of the dimension in which the symbol is created |
|
Virtual | True or false | The default value is false |
receiveRollUps | True or false | The default value is true. |
Name | The name of the symbol |
|
Type | Standard, Static, or CarryForward |
|
balanceType | Credit, Debit, or Neither | Symbols in the Accounts dimension can have a balanceType of Credit, Debit, or Neither. Symbols in all other dimensions have a balanceType of Neither. The default value is Neither. |
sortChildren | Ascending, Descending, or Manual | The default value is Manual |
Description | The description of the symbol | The system allows for multiple language descriptions. Each one is specified with a two character language code, such as en. |
For more information on attributes, see the Longview Application Administrator Guide.
The response from the Data Server is similar to the following example:
V7 Response |
<_:createResponse xmlns:_="http://longview.com/dataservices/WebServices/ Symbol" xmlns="http://longview.com/dataservices" xmlns:tns="http:// longview.com/dataservices/webServiceObject" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <_:createResult> <tns:type>Success</tns:type> <tns:code>0</tns:code> </_:createResult> </_:createResponse> |
Delete
The Delete function sends a request to delete existing symbols in the Longview system. The request to delete symbols is similar to the following example:
V7 Request |
<sym:deleteRequest> <!--1 or more repetitions:--> <web:symbol> <web:dimension>Accounts</web:dimension> <web:symbol>TestNew</web:symbol> </web:symbol> </sym:deleteRequest> |
Element.Attribute | Value |
|---|---|
Dimension | A dimension name |
Symbol | A symbol name |
The response from the Data Server is similar to the following example:
V7 Response |
<_:deleteResponse xmlns:_="http://longview.com/dataservices/WebServices/ Symbol" xmlns="http://longview.com/dataservices" xmlns:tns="http:// longview.com/dataservices/webServiceObject" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <_:deleteResult> <tns:type>Success</tns:type> <tns:code>0</tns:code> </_:deleteResult> </_:deleteResponse> |
Remove Parent
The Remove Parent function sends a request to remove a symbol that is currently attached to a parent in the Longview system. The request to remove parent-child relationships is similar to the following example:
V7 Request |
<sym:removeParentrequest> <!--1 or more repetitions:--> <web:removeParent> <web:dimension>Accounts</web:dimension> <web:child>41010</web:child> <web:parent>TestNew</web:parent> </web:removeParent> <web:removeParent> <web:dimension>Accounts</web:dimension> <web:child>41200</web:child> <web:parent>TestNew</web:parent> </web:removeParent> </sym:removeParentrequest> |
Element.Attribute | Value |
|---|---|
Dimension | A dimension name |
Child | A child symbol name |
Parent | A parent symbol name |
The response from the Data Server is similar to the following example:
V7 Response |
<_:removeParentResponse xmlns:_="http://longview.com/dataservices/ WebServices/Symbol" xmlns="http://longview.com/dataservices" xmlns:tns="http:// longview.com/dataservices/webServiceObject" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <_:removeParentResult> <tns:type>Success</tns:type> <tns:code>0</tns:code> </_:removeParentResult> </_:removeParentResponse> |
Retrieve
The Retrieve function sends a request to retrieve symbols based on a symbol specification in the Longview system. There are two main types of information retrieved in this method:
- Symbol information—This includes fields such as name, index, descriptions, type, priority, etc and relates to the specific symbol.
- Parentage information—This includes fields such as the symbol indexes of the parents of each specific symbol and the weight of the symbol/parent rollups.
The request to retrieve symbols is similar to the following example:
V7 Request |
<sym:retrieveRequest> <!--Optional:--> <web:dimension>Accounts</web:dimension> <!--Zero or more repetitions:--> <web:symbolSpec>Trial_Balance###</web:symbolSpec> </sym:retrieveRequest> |
Element.Attribute | Value | Notes |
|---|---|---|
Dimension | A dimension name |
|
symbolSpec | A symbol name and notation, such as IAS_Statements#99 (99 levels of the IAS_Statements hierarchy) | When only the symbol name is specified, the default is #0. A symbol does not need to be specified, in which case all symbols in the dimension are retrieved. |
The response from the Data Server is similar to the following example:
V7 Response |
<_:retrieveResponse xmlns:_="http://longview.com/dataservices/WebServices/Symbol" xmlns="http://longview.com/dataservices" xmlns:tns="http://longview.com/dataservices/ webServiceObject" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <_:retrieveResult> <tns:status> <tns:type>Success</tns:type> <tns:code>0</tns:code> </tns:status> <tns:symbol xmlns:ns0="http://longview.com/dataservices/WebServices/Data" xmlns:ns1="http://longview.com/dataservices/WebServices/Symbol"> <tns:symbolInfo virtual="false" receiveRollups="true"> <tns:name>11101</tns:name> <tns:type>CarryForward</tns:type> <tns:balanceType>Debit</tns:balanceType> <tns:sortChildren>Manual</tns:sortChildren> <tns:description> <tns:language>en</tns:language> <tns:description>11101 - Cash</tns:description> </tns:description> <tns:description> <tns:language>fr</tns:language> <tns:description>11101 - Comptant</tns:description> </tns:description> </tns:symbolInfo> <tns:parent priority="50"> <tns:name>11100</tns:name> <tns:weight>+</tns:weight> </tns:parent> </tns:symbol> <tns:symbol xmlns:ns0="http://longview.com/dataservices/WebServices/Data" xmlns:ns1="http://longview.com/dataservices/WebServices/Symbol"> <tns:symbolInfo virtual="false" receiveRollups="true"> <tns:name>11110</tns:name> <tns:type>CarryForward</tns:type> <tns:balanceType>Debit</tns:balanceType> <tns:sortChildren>Manual</tns:sortChildren> <tns:description> <tns:language>en</tns:language> <tns:description>11110 - Temporary cash investments</tns:description> </tns:description> <tns:description> <tns:language>fr</tns:language> <tns:description>11110 - Invest. comptant temp.</tns:description> </tns:description> </tns:symbolInfo> <tns:parent priority="60"> <tns:name>11100</tns:name> <tns:weight>+</tns:weight> </tns:parent> </tns:symbol> … </_:retrieveResult> </_:retrieveResponse> |
Element.Attribute | Value | Notes |
|---|---|---|
Type | Error, Success, or Warning |
|
Virtual | True or false |
|
receiveRollUps | True or false |
|
Name | A symbol name |
|
Type | Standard, Static, or CarryForward |
|
balnceType | Credit, Debit, or Neither | Symbols in the Accounts dimension can have a balanceType of Credit, Debit, or Neither. Symbols in all other dimensions have a balanceType of Neither. |
sortChildren | Ascending, Descending, or Manual | Sort children by name (ascending or descending) or manually. |
Language | A two-character language code, such as en |
|
Description |
| The system allows for multiple language descriptions. Each one is specified with a two character language code, such as en. |
Child | A child symbol name |
|
Parent | A parent symbol name |
|
Weight | +, -, or - |
|
Priority | An integer |
|
Update
The Update web service sends a request to update properties of an existing symbol in the Longview system. The request to update symbol information is similar to the following example:
V7 Request |
<sym:updateRequest> <!--Zero or more repetitions:--> <web:symbol> <web:dimension>Accounts</web:dimension> <!--Optional:--> <web:newName>TestNew</web:newName> <!--Optional:--> <web:symbolInfo virtual="true" receiveRollups="true"> <web:name>Test</web:name> </web:symbolInfo> </web:symbol> </sym:updateRequest> |
Element.Attribute | Value | Notes |
|---|---|---|
Dimension | A dimension name |
|
newName | The new name of the symbol | This is optional. A new symbol name is only required when you are renaming a symbol. |
Virtual | True or false | This is optional. If virtual is not specified, the previous value is kept. |
receiveRollUps | True or false | This is optional. If receiveRollUps is not specified, the previous value is kept. |
Name | The name of the symbol |
|
Type | Standard, Static, or CarryForward | This is optional. If type is not specified, the previous value is kept. |
balanceType | Credit, Debit, or Neither | This is optional. If balanceType is not specified, the previous value is kept. Symbols in the Accounts dimension can have a balanceType of Credit, Debit, or Neither. Symbols in all other dimensions have a balanceType of Neither. |
sortChildren | Ascending, Descending, or Manual | This is optional. If sortChildren is not specified, the previous value is kept. |
Language | A two-character language code, such as en |
|
Description | The description of the symbol | This is optional. If description is not specified, the previous value is kept. |
The response from the Data Server is similar to the following example:
V7 Response |
<_:updateResponse xmlns:_="http://longview.com/dataservices/WebServices/ Symbol" xmlns="http://longview.com/dataservices" xmlns:tns="http:// longview.com/dataservices/webServiceObject" xmlns:xsi="http://www.w3.org/ 2001/XMLSchema-instance"> <_:updateResult> <tns:type>Success</tns:type> <tns:code>0</tns:code> </_:updateResult> </_:updateResponse> |