...
Example SELECT query for retrieving Services and related records:
Code Blocknoformat | ||
---|---|---|
| ||
SELECT * FROM SERVICES_CHARGES; |
...
Name | Datatype | Searchable | Notes |
---|---|---|---|
BILLABLE | Yes/No | Yes | To indicate whether the service item is or is not billable |
STATUS_DATE | string | Yes | Shows the date when the service was set to its current status |
SERVICE_HOST | string | Yes | The Service Host associated with the service |
SERVICE_ID | string | Yes | Service Id (phone_number, etc.) |
SERVICE_ID_FMT | string | Yes | Formatted Service Id |
CATALOG | string | Yes | Service Catalog name |
OWNER | string | Yes | Name of the service owner – either a person or org hierarchy |
LOCATIONS_PATH | string | Yes | The hierarchical path to the location of the service; use LOCATIONS when searching |
SLA_CATALOG_PATH | string | Yes | The hierarchical path to the SLA of the service; use SLA when searching |
SERVICES_STATUS | string | Yes | The current status of the service |
SERVICES_UDF | list | No | List of all the User Defined Fields and the selected values for this service |
SERVICES_CHARGES | list | No | Charges listed for this service |
SERVICES_CONTACTS | list | No | Contacts associated with the service |
SERVICES_EQUIPMENT | list | No | Pieces of equipment to be used/listed for this service |
SERVICES_EXPENSE_GLA | list | No | Expense G/L Accounts to be used for billing of this service |
SERVICES_REMARKS | list | No | List of all remarks/comments for this service |
Results
Code Blocknoformat | ||
---|---|---|
| ||
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>1331<<total_count>1331</total_count>count> <services><services> <item><item> <RECID>2488</RECID><RECID>2488</RECID> <MODIFIED_DATE>2014-<MODIFIED_DATE>2014-08-22 12:37:49<49</MODIFIED_DATE>DATE> <BILLABLE>Yes</BILLABLE><BILLABLE>Yes</BILLABLE> <STATUS_DATE>2014<STATUS_DATE>2014-07-11 15:35:38<38</STATUS_DATE>DATE> <CAT_RECID>46<<CAT_RECID>46</CAT_RECID>RECID> <SERVICE<SERVICE_HOST/>> <SERVICE_ID>5555555555<<SERVICE_ID>5555555555</SERVICE_ID>ID> <SERVICE<SERVICE_ID_FMT>FMT>(555) 555-5555<5555</SERVICE_ID_FMT>FMT> <CATALOG>Amazing Product</CATALOG><CATALOG>Amazing Product</CATALOG> <OWNER>Blue Alert</OWNER><OWNER>Blue Alert</OWNER> <MODIFIED_BY>PCR User<<MODIFIED_BY>PCR User</MODIFIED_BY>BY> <LOCATIONS<LOCATIONS_PATH/>> <SLA<SLA_CATALOG_PATH/>> <S<S_SERVICE_STATUS_VALUE>Active<VALUE>Active</S_SERVICE_STATUS_VALUE>VALUE> <SERVICE_STATUS>ACTIVE<<SERVICE_STATUS>ACTIVE</SERVICE_STATUS>STATUS> <SERVICES_UDF><SERVICES_UDF> <item><item> <LABEL>Label</LABEL> <LABEL>Label</LABEL> <VALUE>value</VALUE><VALUE>value</VALUE> </item></item> <</SERVICES_UDF>UDF> <SERVICES_CHARGES><SERVICES_CHARGES> <item><item> <RECID>956</RECID><RECID>956</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2014<MODIFIED_DATE>2014-07-21 14:55:11<11</MODIFIED_DATE>DATE> <MODIFIED_BY>PCR User</MODIFIED_BY><MODIFIED_BY>PCR User</MODIFIED_BY> <SERVICES_RECID>29<<SERVICES_RECID>29</SERVICES_RECID>RECID> <CHRG<CHRG_CATALOG_RECID>57<RECID>57</CHRG_CATALOG_RECID>RECID> <DESCRIPTION/><DESCRIPTION/> <AMOUNT>50</AMOUNT><AMOUNT>50</AMOUNT> <BILL<BILL_DATE/>> <PRORATE>0</PRORATE><PRORATE>0</PRORATE> <EXPENSE<EXPENSE_GLA_RECID/>> <QUANTITY/><QUANTITY/> <CATALOG_NAME>name<<CATALOG_NAME>name</CATALOG_NAME>NAME> <CATALOG_DESCRIPTION>description<<CATALOG_DESCRIPTION>description</CATALOG_DESCRIPTION>DESCRIPTION> <CATALOG_AMOUNT>199<<CATALOG_AMOUNT>199</CATALOG_AMOUNT>AMOUNT> </item></item> <</SERVICES_CHARGES>CHARGES> <SERVICES_CONTACTS><SERVICES_CONTACTS> <item><item> <RECID>2523</RECID><RECID>2523</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2013-<MODIFIED_DATE>2013-06-05 10:25:56<56</MODIFIED_DATE>DATE> <MODIFIED_BY>PCR User<<MODIFIED_BY>PCR User</MODIFIED_BY>BY> <SERVICES_RECID>1767<<SERVICES_RECID>1767</SERVICES_RECID>RECID> <CONTACTS_RECID>34<<CONTACTS_RECID>34</CONTACTS_RECID>RECID> <FIRST_NAME>John<<FIRST_NAME>John</FIRST_NAME>NAME> <LAST_NAME>Doe<<LAST_NAME>Doe</LAST_NAME>NAME> </item></item> <</SERVICES_CONTACTS>CONTACTS> <SERVICES_EQUIPMENT><SERVICES_EQUIPMENT> <item><item> <RECID>71</RECID><RECID>71</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2015<MODIFIED_DATE>2015-03-26 13:38:34<34</MODIFIED_DATE>DATE> <MODIFIED_BY>PCR User<<MODIFIED_BY>PCR User</MODIFIED_BY>BY> <SERVICES_RECID>1697<<SERVICES_RECID>1697</SERVICES_RECID>RECID> <EQUIPMENT_RECID>3078<<EQUIPMENT_RECID>3078</EQUIPMENT_RECID>RECID> <SERVICE_ID>0000001234<<SERVICE_ID>0000001234</SERVICE_ID>ID> <SERV<SERV_CATALOG_RECID>56<RECID>56</SERV_CATALOG_RECID>RECID> <OWNER<OWNER_CONTACTS_RECID/>> <OWNER<OWNER_DEPT_HIERARCHY_RECID>47<RECID>47</OWNER_DEPT_HIERARCHY_RECID>RECID> <BILLABLE>No</BILLABLE><BILLABLE>No</BILLABLE> <SERVICE<SERVICE_STATUS_LISTS_RECID>1321<RECID>1321</SERVICE_STATUS_LISTS_RECID>RECID> <STATUS_DATE>2015<STATUS_DATE>2015-03-10 13:24:27<27</STATUS_DATE>DATE> <SERVICE<SERVICE_HOSTS_RECID>26<RECID>26</SERVICE_HOSTS_RECID>RECID> <SLA<SLA_CATALOG_RECID/>> <LOCATIONS_RECID>66<<LOCATIONS_RECID>66</LOCATIONS_RECID>RECID> <REFERENCE/><REFERENCE/> <ESSENTIAL>0</ESSENTIAL><ESSENTIAL>0</ESSENTIAL> <BILLING<BILLING_GROUPS_RECID/>> <SERVICE<SERVICE_ID_FMT>FMT>(000) 000-1234<1234</SERVICE_ID_FMT>FMT> <EQP<EQP_STATUS_LISTS_RECID>1175<RECID>1175</EQP_STATUS_LISTS_RECID>RECID> <EQP<EQP_CATALOG_RECID>71<RECID>71</EQP_CATALOG_RECID>RECID> <SERIAL_NUM>006A<<SERIAL_NUM>006A</SERIAL_NUM>NUM> <SERIAL<SERIAL_NUM_BARCODE/>> <EQUIPMENT_ID>006A<<EQUIPMENT_ID>006A</EQUIPMENT_ID>ID> <ASSET<ASSET_TAG/>> <CONSUMED>No</CONSUMED><CONSUMED>No</CONSUMED> <PURCHASE<PURCHASE_PRICE/>> <RECEIVED<RECEIVED_DATE/>> <BILLED<BILLED_DATE/>> <CARD<CARD_NUMBER/>> <PARENT<PARENT_EQUIPMENT_RECID/>> <CABLING<CABLING_EQP_TYPE_LISTS_RECID/>> <IP4<IP4_GATEWAY/>> <IP6<IP6_GATEWAY/>> <LAN<LAN_NAME/>> <MAC<MAC_ADDRESS/>> <IP4<IP4_ADDRESS/>> <IP6<IP6_ADDRESS/>> <IP4<IP4_SUBNET_MASK/>> <IP6<IP6_SUBNET_MASK/>> <IP4<IP4_GATEWAY_ADDRESS/>> <IP6<IP6_GATEWAY_ADDRESS/>> <HOST<HOST_NAME/>> <EQP<EQP_CONDITION_LISTS_RECID/>> <ORDERED<ORDERED_DATE/>> <UNITS/><UNITS/> <WARRANTY<WARRANTY_END_DATE/>> <USE_DHCP>0<<USE_DHCP>0</USE_DHCP>DHCP> <PRIVATE>0</PRIVATE><PRIVATE>0</PRIVATE> <STATUS>Active</STATUS><STATUS>Active</STATUS> <PART_NUMBER>ABC123<<PART_NUMBER>ABC123</PART_NUMBER>NUMBER> <PART<PART_NUM_BARCODE/>> <DESCRIPTION>ABC123</DESCRIPTION><DESCRIPTION>ABC123</DESCRIPTION> <MANUFACTURER/><MANUFACTURER/> <MANU<MANU_PART_NUM/>> <CATALOG<CATALOG_DESCRIPTION/>> <CATEGORY>No</CATEGORY><CATEGORY>No</CATEGORY> <PRORATE>No</PRORATE><PRORATE>No</PRORATE> <ASSIGNABLE>No</ASSIGNABLE><ASSIGNABLE>No</ASSIGNABLE> <CABLING_EQUIPMENT>Yes<<CABLING_EQUIPMENT>Yes</CABLING_EQUIPMENT>EQUIPMENT> <ASSET>No</ASSET><ASSET>No</ASSET> <LOCATION_REQUIRED>No<<LOCATION_REQUIRED>No</LOCATION_REQUIRED>REQUIRED> <ORDERABLE>0</ORDERABLE><ORDERABLE>0</ORDERABLE> <CONSUMABLE>No</CONSUMABLE><CONSUMABLE>No</CONSUMABLE> <PROVISIONED>0</PROVISIONED><PROVISIONED>0</PROVISIONED> <REVENUE<REVENUE_GLA_RECID>45<RECID>45</REVENUE_GLA_RECID>RECID> <REVENUE<REVENUE_OB_CODES_RECID>6<RECID>6</REVENUE_OB_CODES_RECID>RECID> <EXPENSE<EXPENSE_OB_CODES_RECID>6<RECID>6</EXPENSE_OB_CODES_RECID>RECID> <WORKER<WORKER_INSTALL_TIME>3600<TIME>3600</WORKER_INSTALL_TIME>TIME> <WORKER<WORKER_REMOVE_TIME>3600<TIME>3600</WORKER_REMOVE_TIME>TIME> <MAX<MAX_QUANTITY/>> <PARENT<PARENT_EQP_CATALOG_RECID/>> <WARRANTY<WARRANTY_LENGTH_LISTS_RECID/>> <HEIGHT/><HEIGHT/> <WIDTH/><WIDTH/> <SLOTS/><SLOTS/> <UNIT<UNIT_LISTS_RECID>1342<RECID>1342</UNIT_LISTS_RECID>RECID> <HAS_UNITS>0<<HAS_UNITS>0</HAS_UNITS>UNITS> <CONTIGUOUS>0</CONTIGUOUS><CONTIGUOUS>0</CONTIGUOUS> </item></item> <</SERVICES_EQUIPMENT>EQUIPMENT> <SERVICES<SERVICES_EXPENSE_GLA>GLA> <item><item> <PERCENT>100</PERCENT><PERCENT>100</PERCENT> <Type>Default</Type><Type>Default</Type> <GLA<GLA_FULL_CODES_0>100 >0>100 > 200 >> 300 > 400<> 400</GLA_FULL_CODES_0>0> </item></item> <</SERVICES_EXPENSE_GLA>GLA> <SERVICES_REMARKS><SERVICES_REMARKS> <item><item> <RECID>74</RECID><RECID>74</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2013<MODIFIED_DATE>2013-07-05 14:04:51<51</MODIFIED_DATE>DATE> <MODIFIED_BY>PCR User<<MODIFIED_BY>PCR User</MODIFIED_BY>BY> <SERVICES_RECID>1697<<SERVICES_RECID>1697</SERVICES_RECID>RECID> <REMARKS>These<REMARKS>These are the remarks</REMARKS>remarks</REMARKS> </item></item> <</SERVICES_REMARKS>REMARKS> </item></item> </services></services> </services></services> |
Lists
When inserting or updating Service records, it is sometimes necessary to provide values that exist elsewhere in the system. The LIST method can help to retrieve available options for these values.
...
No Format |
---|
GET http://DOMAIN/api/API_KEY/services.OUTPUT?LIST=LISTTYPE&SEARCH=test |
Parameter | Replace With |
---|---|
LISTTYPE | The type of List to be retrieved. Types can be found below. |
...
Contacts Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <contacts><contacts> <item><item> <RECID>809</RECID><RECID>809</RECID> <SERVICE_REP>Doe, John<<SERVICE_REP>Doe, John</SERVICE_REP>REP> <STATUS>1</STATUS><STATUS>1</STATUS> <CONTACT<CONTACT_TYPE_LISTS_RECID>1147<RECID>1147</CONTACT_TYPE_LISTS_RECID>RECID> <C<C_TITLE_VALUE/>> <C<C_TITLE_CODE/>> <CTYPE<CTYPE_CONTACT_TYPE_VALUE>User<VALUE>User</CTYPE_CONTACT_TYPE_VALUE>VALUE> <CTYPE<CTYPE_CONTACT_TYPE_CODE>USER<CODE>USER</CTYPE_CONTACT_TYPE_CODE>CODE> </item></item> </contacts></contacts> </services></services> |
Department Hierarchy Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <depthier><depthier> <item><item> <RECID>24</RECID><RECID>24</RECID> <DH_NAME>Facilities<<DH_NAME>Facilities</DH_NAME>NAME> <STATUS>1</STATUS><STATUS>1</STATUS> <DEFAULT<DEFAULT_SLA_DESC/>> <DEFAULT<DEFAULT_INCI_SLA_DESC/>> <BG_NAME>Admin<<BG_NAME>Admin</BG_NAME>NAME> <DEPT<DEPT_HIERARCHY_PATH>FM<PATH>FM</DEPT_HIERARCHY_PATH>PATH> <DEPT<DEPT_HIERARCHY_PATH_TOOLTIP>FM<TOOLTIP>FM</DEPT_HIERARCHY_PATH_TOOLTIP>TOOLTIP> <NAME<NAME_AND_BG>FMBG>FM - Admin<Admin</NAME_AND_BG>BG> </item></item> </depthier></depthier> </services></services> |
Expense Types Results
No Format |
---|
<services> <services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <expense_type><expense_type> <item><item> <RECID>1182</RECID><RECID>1182</RECID> <VALUE>Default</VALUE><VALUE>Default</VALUE> </item></item> <</expense_type>type> </services></services> |
GLAs Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <glas><glas> <item><item> <RECID>1</RECID><RECID>1</RECID> <NAME>ACCOUNT</NAME><NAME>ACCOUNT</NAME> <DESCRIPTION>GLA<DESCRIPTION>GLA Format for Account Billing Group</DESCRIPTION>Group</DESCRIPTION> </item></item> </glas></glas> </services></services> |
Locations Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <locations><locations> <item><item> <RECID>261</RECID><RECID>261</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2015<MODIFIED_DATE>2015-01-02 16:47:00<00</MODIFIED_DATE>DATE> <MODIFIED_BY>hsolo<<MODIFIED_BY>hsolo</MODIFIED_BY>BY> <STATUS>1</STATUS><STATUS>1</STATUS> <WAREHOUSE_FLAG>0</WAREHOUSE_FLAG><WAREHOUSE_FLAG>0</WAREHOUSE_FLAG> <REPORT_911>0<<REPORT_911>0</REPORT_911>911> <DEFAULT<DEFAULT_WH_LOCATIONS_RECID/>> <PARENT<PARENT_LOCATIONS_RECID>7<RECID>7</PARENT_LOCATIONS_RECID>RECID> <LOCATION<LOCATION_TYPE_LISTS_RECID/>> <NAME>Tatooine</NAME><NAME>Tatooine</NAME> <BUILDING<BUILDING_NUMBER/>> <BUILDING<BUILDING_ADDRESSES_RECID/>> <MASTER<MASTER_DEFAULT_WAREHOUSE>0<WAREHOUSE>0</MASTER_DEFAULT_WAREHOUSE>WAREHOUSE> <LATITUDE/><LATITUDE/> <LONGITUDE/><LONGITUDE/> <DEFAULT<DEFAULT_RETURN_WAREHOUSE>0<WAREHOUSE>0</DEFAULT_RETURN_WAREHOUSE>WAREHOUSE> <DEFAULT<DEFAULT_RWH_LOCATIONS_RECID/>> <COMMUNITY<COMMUNITY_NAME/>> <L<L_LOCATION_TYPE_VALUE/>> <L<L_LOCATION_TYPE_CODE/>> </item></item> </locations></locations> </services></services> |
Charge Catalog Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>64</count><count>64</count> <total_count>64<<total_count>64</total_count>count> <charge_catalog><charge_catalog> <item><item> <RECID>167</RECID><RECID>167</RECID> <NAME>Starship Detailing</NAME><NAME>Starship Detailing</NAME> <DESCRIPTION>1<DESCRIPTION>1-time charge for cleaning of starships</DESCRIPTION>starships</DESCRIPTION> <AMOUNT>126587</AMOUNT><AMOUNT>126587</AMOUNT> <CHARGE<CHARGE_TYPE_LISTS_RECID>1981<RECID>1981</CHARGE_TYPE_LISTS_RECID>RECID> <EXPENSE<EXPENSE_TYPE_LISTS_RECID>1182<RECID>1182</EXPENSE_TYPE_LISTS_RECID>RECID> <PARENT<PARENT_CHRG_CATALOG_RECID/>> <REVENUE<REVENUE_GLA_RECID>1<RECID>1</REVENUE_GLA_RECID>RECID> <USE_QUANTITY>1<<USE_QUANTITY>1</USE_QUANTITY>QUANTITY> <TAXABLE>0</TAXABLE><TAXABLE>0</TAXABLE> <ALLOW_OVERRIDE>1<<ALLOW_OVERRIDE>1</ALLOW_OVERRIDE>OVERRIDE> <CC<CC_CHARGE_TYPE_VALUE>1 time</VALUE>1 time</CC_CHARGE_TYPE_VALUE>VALUE> <CC<CC_CHARGE_TYPE_CODE>1_TIME<CODE>1_TIME</CC_CHARGE_TYPE_CODE>CODE> <CC<CC_EXPENSE_TYPE_VALUE>Default<VALUE>Default</CC_EXPENSE_TYPE_VALUE>VALUE> <CC<CC_EXPENSE_TYPE_CODE>DEFAULT<CODE>DEFAULT</CC_EXPENSE_TYPE_CODE>CODE> </item></item> <</charge_catalog>catalog> </services></services> |
Service Catalog Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page> <page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <service_catalog><service_catalog> <item><item> <RECID>1</RECID><RECID>1</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2013<MODIFIED_DATE>2013-08-07 13:13:06<06</MODIFIED_DATE>DATE> <MODIFIED_BY>lorgana</MODIFIED_BY><MODIFIED_BY>lorgana</MODIFIED_BY> <STATUS>1</STATUS><STATUS>1</STATUS> <SERVICE_NAME>Force Training<<SERVICE_NAME>Force Training</SERVICE_NAME>NAME> <SERVICE<SERVICE_TYPE_LISTS_RECID>1329<RECID>1329</SERVICE_TYPE_LISTS_RECID>RECID> <PARENT<PARENT_SERV_CATALOG_RECID/>> <DESCRIPTION>Learn<DESCRIPTION>Learn to use the force</DESCRIPTION>force</DESCRIPTION> <CATALOG_DESCRIPTION><<CATALOG_DESCRIPTION></CATALOG_DESCRIPTION>DESCRIPTION> <CATEGORY>0</CATEGORY><CATEGORY>0</CATEGORY> <PRORATE>0</PRORATE><PRORATE>0</PRORATE> <ASSIGNABLE>1</ASSIGNABLE><ASSIGNABLE>1</ASSIGNABLE> <BILLABLE>1</BILLABLE><BILLABLE>1</BILLABLE> <LOCATION_REQUIRED>0<<LOCATION_REQUIRED>0</LOCATION_REQUIRED>REQUIRED> <REQUIRES_APPROVAL>0<<REQUIRES_APPROVAL>0</REQUIRES_APPROVAL>APPROVAL> <ORDERABLE>1</ORDERABLE><ORDERABLE>1</ORDERABLE> <DEFAULT<DEFAULT_SERVICE_HOSTS_RECID/>> <<WORKER_INSTALL_TIME>3600</WORKER_INSTALL_TIME>3600</WORKER_INSTALL_TIME>TIME> <WORKER<WORKER_REMOVE_TIME>5400<TIME>5400</WORKER_REMOVE_TIME>TIME> <REVENUE<REVENUE_GLA_RECID>4<RECID>4</REVENUE_GLA_RECID>RECID> <REVENUE<REVENUE_OB_CODES_RECID>1<RECID>1</REVENUE_OB_CODES_RECID>RECID> <AGING/><AGING/> <REPORT_911>0<<REPORT_911>0</REPORT_911>911> <FORMAT/><FORMAT/> <BILLING<BILLING_GROUP_RESTRICT/>> <EQUIPMENT<EQUIPMENT_RESTRICT/>> <LOCATION_<LOCATION_RESTRICT/>> </item></item> <</service_catalog>catalog> </services></services> |
Service Hosts Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <service_hosts><service_hosts> <item><item> <RECID>31</RECID><RECID>31</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2013<MODIFIED_DATE>2013-12-18 14:45:06<06</MODIFIED_DATE>DATE> <MODIFIED_BY>dvader<<MODIFIED_BY>dvader</MODIFIED_BY>BY> <STATUS>1</STATUS><STATUS>1</STATUS> <NAME>GNetwork</NAME><NAME>GNetwork</NAME> <HOST<HOST_TYPES_LISTS_RECID>1198<RECID>1198</HOST_TYPES_LISTS_RECID>RECID> <SWITCH<SWITCH_TYPES_LISTS_RECID/>> <DEFAULT<DEFAULT_NPA/>> <DEFAULT<DEFAULT_NXX/>> <UPDATE_REQUIRED>0<<UPDATE_REQUIRED>0</UPDATE_REQUIRED>REQUIRED> <DIAL<DIAL_PLAN/>> <IP<IP_ADDRESS/>> <NETWORK<NETWORK_PORT/>> <USERNAME/><USERNAME/> <PASSWORD/><PASSWORD/> <VERSION/><VERSION/> <WSDL<WSDL_URI/>> <HOST<HOST_ADDRESS/>> <DATA<DATA_ENCODING/>> <REQUEST<REQUEST_HEADERS/>> </item></item> <</service_hosts>hosts> </services></services> |
UDFs Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <udfs><udfs> <item><item> <RECID>3</RECID><RECID>3</RECID> <PRCODE>General</PRCODE><PRCODE>General</PRCODE> </item></item> </udfs></udfs> </services></services> |
SLAs Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <slas> <slas> <item> <item> <RECID>3</RECID><RECID>3</RECID> <VALUE>General</VALUE><VALUE>General</VALUE> </item></item> </slas></slas> </services></services> |
Service Pools Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <pools><pools> <item><item> <RECID>11</RECID><RECID>11</RECID> <VALUE>IT</VALUE><VALUE>IT</VALUE> </item></item> </pools></pools> </services></services> |
Service Classes Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <service_classes><service_classes> <item><item> <RECID>16</RECID><RECID>16</RECID> <VALUE>SC Name</VALUE><VALUE>SC Name</VALUE> </item></item> <</service_classes>classes> </services></services> |
Service Host Partitions Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <service<service_host_partitions>partitions> <item><item> <RECID>54</RECID><RECID>54</RECID> <TENANTS_RECID>0<<TENANTS_RECID>0</TENANTS_RECID>RECID> <MODIFIED_DATE>2015<MODIFIED_DATE>2015-11-06 15:05:04<04</MODIFIED_DATE>DATE> <MODIFIED_BY>cbacca<<MODIFIED_BY>cbacca</MODIFIED_BY>BY> <SERVICE<SERVICE_HOSTS_RECID>46<RECID>46</SERVICE_HOSTS_RECID>RECID> <PARTITIONS_NAME>Default<<PARTITIONS_NAME>Default</PARTITIONS_NAME>NAME> <PARTITIONS_DESC>Default Partition<<PARTITIONS_DESC>Default Partition</PARTITIONS_DESC>DESC> </item></item> <</service_host_partitions>partitions> </services></services> |
Auth Code Types Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>1<<total_count>1</total_count>count> <auth<auth_code_types>types> <item><item> <RECID>3</RECID><RECID>3</RECID> <VALUE>General</VALUE><VALUE>General</VALUE> </item></item> <</auth_code_types>types> </services></services> |
Bandwidth Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>1<<total_count>1</total_count>count> <bandwidth><bandwidth> <item><item> <RECID>3</RECID><RECID>3</RECID> <VALUE>1 Gbps</VALUE><VALUE>1 Gbps</VALUE> </item></item> </bandwidth></bandwidth> </services></services> |
Rating Groups Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <rating_group><rating_group> <item><item> <RECID>1890</RECID><RECID>1890</RECID> <VALUE>Group_1</VALUE><VALUE>Group_1</VALUE> </item></item> <</rating_group>group> </services></services> |
Service Statuses Results
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>20</count><count>20</count> <total_count>20<<total_count>20</total_count>count> <service_status><service_status> <item><item> <RECID>3</RECID><RECID>3</RECID> <VALUE>Active</VALUE><VALUE>Active</VALUE> </item></item> <</service_status>status> </services></services> |
Write Call
This version of the API is available starting in 2.1.0.0
...
If the request is successful, the Service RECID will be returns as follows:
No Format |
---|
<service><service> <status>success</status><status>success</status> <page>1</page> <page>1</page> <count>1</count><count>1</count> <total_count>0<<total_count>0</total_count>count> <service>54875</service><service>54875</service> </service></service> |
Service Form App Record
Service Pools
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=POOLS&field1=value1 ... |
Available Fields
...
If the request is successful, the Recid(s) of the linking records will be returned in same order as provided:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>0<<total_count>0</total_count>count> <services><services> <item>2312</item><item>2312</item> <item>2313</item><item>2313</item> </services></services> </services></services> |
Service Form Pools Tab App Record
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=REMARK&field1=value1 ... |
Available Fields
...
If the request is successful, the Recid of the remark record will be returned as follows:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>0<<total_count>0</total_count>count> <services>456231</services><services>456231</services> </services></services> |
Service Form Remarks Tab App Record
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=CHARGES&field1=value1 ... |
Available Fields
...
If the request is successful, the RECID of the new Service charge is returned as follows:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>1</total_count><total_count>1</total_count> <services>58337</services><services>58337</services> </services></services> |
Service Form Charges Tab App Record
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=GLA&field1=value1 ... |
If multiple GLAs are to be set, structure your request as follows:
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=GLA&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma separated values, each place in the string corresponds to the same space in other field value strings.
...
If the request is successful, the RECID(s) of the new Service GLA records will be returned in the same order as provided:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>1<<total_count>1</total_count>count> <services><services> <item>234</item><item>234</item> <item>235</item><item>235</item> </services></services> </services></services> |
Service Form GLA Tab App Record
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=CONTACTS&field1=value1 ... |
Available Fields
...
If the request is successful, the RECID(s) of the new service contact records will be returned in the same order as provided:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>1<<total_count>1</total_count>count> <services><services> <item>123</item><item>123</item> <item>124</item><item>124</item> </services></services> </services></services> |
Service Form Contacts Tab App Record
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=UDFS&field1=value1 ... |
Available Fields
...
If the request is successful, the RECID(s) of the new Service UDF records will be returned in the same order as provided:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>1</total_count><total_count>1</total_count> <services> <services> <item>5434</item><item>5434</item> <item>5435</item><item>5435</item> </services></services> </services></services> |
Service Form UDF Tab App Record
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=LOCATIONS&field1=value1 ... |
If multiple locations are to be set, structure your request as follows:
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=LOCATIONS&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma separated values, each place in the string corresponds to the same space in other field value strings.
...
If the request is successful, the Recid of the Service Location record(s) will be returned in the same order as provided:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count> <count>1</count> <total_count>0<<total_count>0</total_count>count> <services><services> <item>4545</item><item>4545</item> <item>4546</item><item>4546</item> </services></services> </services></services> |
Service Form Location Tab App Record
...
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=EQUIPMENT&field1=value1 ... |
If multiple Equipment are to be assigned, structure your request as follows:
No Format |
---|
POST http://DOMAIN/api/API_KEY/services.OUTPUT?type=EQUIPMENT&field1=v1.1,v1.2&field2=v2.1,v2.2 ... |
When creating your comma separated values, each place in the string corresponds to the same space in other field value strings.
...
If the request is successful, the Recid of the Service Equipment record(s) will be returned in the order provided:
No Format |
---|
<services><services> <status>success</status><status>success</status> <page>1</page><page>1</page> <count>1</count><count>1</count> <total_count>0<<total_count>0</total_count>count> <services><services> <item>234</item><item>234</item> <item>235</item><item>235</item> </services></services> </services></services> |
Service Form Equipment Tab App Record
...