Versions Compared

Old Version 11

changes.mady.by.user Frank Zerillo

Saved on

compared with

New Version 12

changes.mady.by.user Brian Dixon

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
outlinetrue
stylenone

...

Type

Description

Extra Parameters*

Searchable

Results

CONTACTS

Retrieve available Contacts

CTYPE - Type of contact. Example: "worker"

yes

Contacts Results

Toggle cloak

 Cloak

 Code Block
languagexml
linenumberstrue
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <contacts>
            <item>
                <RECID>809</RECID>
                <SERVICE_REP>Doe, John</SERVICE_REP>
                <STATUS>1</STATUS>
                <CONTACT_TYPE_LISTS_RECID>1147</CONTACT_TYPE_LISTS_RECID>
                <C_TITLE_VALUE/>
                <C_TITLE_CODE/>
                <CTYPE_CONTACT_TYPE_VALUE>User</CTYPE_CONTACT_TYPE_VALUE>
                <CTYPE_CONTACT_TYPE_CODE>USER</CTYPE_CONTACT_TYPE_CODE>
            </item>
        </contacts>
    </services>



DEPTHIER
Retrieve available Department Hierarchies

Coming Soon
Department Hierarchy Results
 Toggle cloak
 Cloak

 Code Block
languagexml
linenumberstrue
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <depthier>
            <item>
                <RECID>24</RECID>
                <DH_NAME>Facilities</DH_NAME>
                <STATUS>1</STATUS>
                <DEFAULT_SLA_DESC/>
                <DEFAULT_INCI_SLA_DESC/>
                <BG_NAME>Admin</BG_NAME>
                <DEPT_HIERARCHY_PATH>FM</DEPT_HIERARCHY_PATH>
                <DEPT_HIERARCHY_PATH_TOOLTIP>FM</DEPT_HIERARCHY_PATH_TOOLTIP>
                <NAME_AND_BG>FM - Admin</NAME_AND_BG>
            </item>
        </depthier>
    </services>



EXPENSE_TYPE
Retrieve available Expense Types

no
Expense Types Results
 Toggle cloak
 Cloak

 Code Block
languagexml
linenumberstrue
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <expense_type>
            <item>
                <RECID>1182</RECID>
                <VALUE>Default</VALUE>
            </item>
        </expense_type>
    </services>



GLAS
Retrieve available GLAs

no
GLAs Results
 Toggle cloak
 Cloak

 Code Block
languagexml
linenumberstrue
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <glas>
            <item>
                <RECID>1</RECID>
                <NAME>ACCOUNT</NAME>
                <DESCRIPTION>GLA Format for Account Billing Group</DESCRIPTION>
            </item>
        </glas>
    </services>



LOCATIONS
Retrieve available Locations

yes
Locations Results
 Toggle cloak

 Cloak

 Code Block
languagexml
linenumberstrue
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <locations>
            <item>
                <RECID>261</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2015-01-02 16:47:00</MODIFIED_DATE>
                <MODIFIED_BY>hsolo</MODIFIED_BY>
                <STATUS>1</STATUS>
                <WAREHOUSE_FLAG>0</WAREHOUSE_FLAG>
                <REPORT_911>0</REPORT_911>
                <DEFAULT_WH_LOCATIONS_RECID/>
                <PARENT_LOCATIONS_RECID>7</PARENT_LOCATIONS_RECID>
                <LOCATION_TYPE_LISTS_RECID/>
                <NAME>Tatooine</NAME>
                <BUILDING_NUMBER/>
                <BUILDING_ADDRESSES_RECID/>
                <MASTER_DEFAULT_WAREHOUSE>0</MASTER_DEFAULT_WAREHOUSE>
                <LATITUDE/>
                <LONGITUDE/>
                <DEFAULT_RETURN_WAREHOUSE>0</DEFAULT_RETURN_WAREHOUSE>
                <DEFAULT_RWH_LOCATIONS_RECID/>
                <COMMUNITY_NAME/>
                <L_LOCATION_TYPE_VALUE/>
                <L_LOCATION_TYPE_CODE/>
            </item>
        </locations>
    </services>



CHARGE_CATALOG
Retrieve available Charge Catalogs

yes
Charge Catalog Results
 Toggle cloak

 Cloak

 Code Block
languagexml
linenumberstrue
    <services>
        <status>success</status>
        <page>1</page>
        <count>64</count>
        <total_count>64</total_count>
        <charge_catalog>
            <item>
                <RECID>167</RECID>
                <NAME>Starship Detailing</NAME>
                <DESCRIPTION>1-time charge for cleaning of starships</DESCRIPTION>
                <AMOUNT>126587</AMOUNT>
                <CHARGE_TYPE_LISTS_RECID>1981</CHARGE_TYPE_LISTS_RECID>
                <EXPENSE_TYPE_LISTS_RECID>1182</EXPENSE_TYPE_LISTS_RECID>
                <PARENT_CHRG_CATALOG_RECID/>
                <REVENUE_GLA_RECID>1</REVENUE_GLA_RECID>
                <USE_QUANTITY>1</USE_QUANTITY>
                <TAXABLE>0</TAXABLE>
                <ALLOW_OVERRIDE>1</ALLOW_OVERRIDE>
                <CC_CHARGE_TYPE_VALUE>1 time</CC_CHARGE_TYPE_VALUE>
                <CC_CHARGE_TYPE_CODE>1_TIME</CC_CHARGE_TYPE_CODE>
                <CC_EXPENSE_TYPE_VALUE>Default</CC_EXPENSE_TYPE_VALUE>
                <CC_EXPENSE_TYPE_CODE>DEFAULT</CC_EXPENSE_TYPE_CODE>
            </item>
        </charge_catalog>
    </services>



SERVICE_CATALOG
Retrieve available Service Catalogs

yes
Service Catalog Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_catalog>
            <item>
                <RECID>1</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2013-08-07 13:13:06</MODIFIED_DATE>
                <MODIFIED_BY>lorgana</MODIFIED_BY>
                <STATUS>1</STATUS>
                <SERVICE_NAME>Force Training</SERVICE_NAME>
                <SERVICE_TYPE_LISTS_RECID>1329</SERVICE_TYPE_LISTS_RECID>
                <PARENT_SERV_CATALOG_RECID/>
                <DESCRIPTION>Learn to use the force</DESCRIPTION>
                <CATALOG_DESCRIPTION></CATALOG_DESCRIPTION>
                <CATEGORY>0</CATEGORY>
                <PRORATE>0</PRORATE>
                <ASSIGNABLE>1</ASSIGNABLE>
                <BILLABLE>1</BILLABLE>
                <LOCATION_REQUIRED>0</LOCATION_REQUIRED>
                <REQUIRES_APPROVAL>0</REQUIRES_APPROVAL>
                <ORDERABLE>1</ORDERABLE>
                <DEFAULT_SERVICE_HOSTS_RECID/>
                <WORKER_INSTALL_TIME>3600</WORKER_INSTALL_TIME>
                <WORKER_REMOVE_TIME>5400</WORKER_REMOVE_TIME>
                <REVENUE_GLA_RECID>4</REVENUE_GLA_RECID>
                <REVENUE_OB_CODES_RECID>1</REVENUE_OB_CODES_RECID>
                <AGING/>
                <REPORT_911>0</REPORT_911>
                <FORMAT/>
                <BILLING_GROUP_RESTRICT/>
                <EQUIPMENT_RESTRICT/>
                <LOCATION_RESTRICT/>
            </item>
        </service_catalog>
    </services>



SERVICE_HOSTS
Retrieve available Service Hosts

no
Service Hosts Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_hosts>
            <item>
                <RECID>31</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2013-12-18 14:45:06</MODIFIED_DATE>
                <MODIFIED_BY>dvader</MODIFIED_BY>
                <STATUS>1</STATUS>
                <NAME>GNetwork</NAME>
                <HOST_TYPES_LISTS_RECID>1198</HOST_TYPES_LISTS_RECID>
                <SWITCH_TYPES_LISTS_RECID/>
                <DEFAULT_NPA/>
                <DEFAULT_NXX/>
                <UPDATE_REQUIRED>0</UPDATE_REQUIRED>
                <DIAL_PLAN/>
                <IP_ADDRESS/>
                <NETWORK_PORT/>
                <USERNAME/>
                <PASSWORD/>
                <VERSION/>
                <WSDL_URI/>
                <HOST_ADDRESS/>
                <DATA_ENCODING/>
                <REQUEST_HEADERS/>
            </item>
        </service_hosts>
    </services>



UDFS
Retrieve available User Defined Fields (UDF)
SERV_CATALOG_RECID (required)
no
UDFs Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <udfs>
            <item>
                <RECID>3</RECID>
                <PRCODE>General</PRCODE>
            </item>
        </udfs>
    </services>



SLAS
Retrieve available SLAs

no
SLAs Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <slas>
            <item>
                <RECID>3</RECID>
                <VALUE>General</VALUE>
            </item>
        </slas>
    </services>



POOLS
Retrieve available Service Pools

no
Service Pools Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <pools>
            <item>
                <RECID>11</RECID>
                <VALUE>IT</VALUE>
            </item>
        </pools>
    </services>



SERVICE_CLASSES
Retrieve available Service Classes

no
Service Classes Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_classes>
            <item>
                <RECID>16</RECID>
                <VALUE>SC Name</VALUE>
            </item>
        </service_classes>
    </services>



SERVICE_HOST_PARTITIONS
Retrieve available Service Host Partitions

no
Service Host Partitions Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <service_host_partitions>
            <item>
                <RECID>54</RECID>
                <TENANTS_RECID>0</TENANTS_RECID>
                <MODIFIED_DATE>2015-11-06 15:05:04</MODIFIED_DATE>
                <MODIFIED_BY>cbacca</MODIFIED_BY>
                <SERVICE_HOSTS_RECID>46</SERVICE_HOSTS_RECID>
                <PARTITIONS_NAME>Default</PARTITIONS_NAME>
                <PARTITIONS_DESC>Default Partition</PARTITIONS_DESC>
            </item>
        </service_host_partitions>
    </services>



AUTH_CODE_TYPE
Retrieve available Auth Code Types

no
Auth Code Types Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <auth_code_types>
            <item>
                <RECID>3</RECID>
                <VALUE>General</VALUE>
            </item>
        </auth_code_types>
    </services>



BANDWIDTH
Retrieve available Bandwidths

no
Bandwidth Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>1</count>
        <total_count>1</total_count>
        <bandwidth>
            <item>
                <RECID>3</RECID>
                <VALUE>1 Gbps</VALUE>
            </item>
        </bandwidth>
    </services>



RATING_GROUP
Retrieve available Rating Groups

no
Rating Groups Results
 Toggle cloak

 Cloak

 Code Block
languagexml
    <services>
        <status>success</status>
        <page>1</page>
        <count>20</count>
        <total_count>20</total_count>
        <rating_group>
            <item>
                <RECID>1890</RECID>
                <VALUE>Group_1</VALUE>
            </item>
        </rating_group>
    </services>



SERVICE_STATUS
Retrieve available Service Statuses

no
Service Status Results
 Toggle cloak
 Cloak

 Code Block
languagexml
linenumberstrue
<services>
    <status>success</status>
    <page>1</page>
    <count>20</count>
    <total_count>20</total_count>
    <service_status>
        <item>
            <RECID>3</RECID>
            <VALUE>Active</VALUE>
        </item>
    </service_status>
</services>



*Extra Parameters can be appended to the URL in standard Query String fashion.
Write Call
 Insert excerpt
SQL API Calls
SQL API Calls
nopaneltrue
Available Fields
Field
Required
Data Type
Options
Default
Notes
recid
no*
Integer


Identifier of the record. *See Note Below
status
yes
Integer38470084
.Services API Calls v2020.4

The status of the service.
serv_catalog
yes
Integer38470084
.Services API Calls v2020.4

Recid of the Service Catalog item.
 Insert excerpt
Bulk Update
Bulk Update
nopaneltrue
service_id
yes
String


Service ID of this service. Before inserting a new record, the system confirms there is no existing matching formatted version. If a match is found, the call will update the appropriate record. The service_id field can be formatted or unformatted. The service_id cannot be updated. *See Note Below.
owner
no*
Integer38470084
.Services API Calls v2020.4

Record ID of either the Contact or the Department owner.
owner_type
no*
String
"contact" or "department"

Type of owner
location
no
Integer38470084
.Services API Calls v2020.4

Recid of location for service.
service_host
no
Integer38470084
.Services API Calls v2020.4

Recid of Service Host for service.
sla
no
Integer38470084
.Services API Calls v2020.4

Recid of SLA for service.
reference
no
String


Reference for service
billable
no
Integer
1 = yes; 0 = no

Designate if the Service is Billable
billing_group
no
Integer38470084
.Services API Calls v2020.4

Recid of billing group for service.
essential
no
Integer
1 = yes; 0 = no

Designate if this is an essential Service.
status_date
yes
String


Date status was set for Service. Format “YYYY/MM/DD”.
assoc_service
no
Integer38470084
.Services API Calls v2020.4

Recid of Associated Service.
equipment
no
String38470084
.Services API Calls v2020.4

Recid(s) of equipment to add to Service. If multiple Equipment are to be assigned, separate Recids with commas. Example: 56,875.
contact
no
String38470084
.Services API Calls v2020.4

Recid(s) of Contacts to add to Service. If multiple contacts are to be assigned, separate recids with commas. Example: 1234,7894.
remarks
no
String


Remarks to add to the Service.
pool
no
String38470084
.Services API Calls v2020.4

Recids of Service pool(s) to add to the Service. If multiple contacts are to be assigned, separate recids with commas. Example: 548,785.
gla
no
Integer38470084
.Services API Calls v2020.4

Recid(s) of GLA record(s) to assign to this service. If multiple GLAs are to be assigned, separate recids with commas. Example: 874,32.
gla_percent
no*
String

100
Percentage(s) of this Service that should apply to specified GLA(s). *If multiple GLAs are provided, then percent is required and the same count of percentages need to be provided also. Total of all percentages must equal exactly 100.
gla_type
no*
String38470084
.Services API Calls v2020.4

List Value(s) of Expense Type(s). *Required if GLA is specified.
directory
yes
Integer
1 = yes; 0 = no

IF service_type = "phone". Designates if this Service is to be listed in the directory.
report_911
yes
Integer
1 = yes; 0 = no

IF service_type = "phone". Designates if this Service is to be listed in emergency 911 feed.
multiple_locations
no
Integer
1 = yes; 0 = no

IF service_type = "phone". Designates if this Service has multiple locations.
bandwidth
no
Integer38470084
.Services API Calls v2020.4

IF service_type = "data" OR "backbone". Recid of bandwidth record.
auth_code_type
no
Integer38470084
.Services API Calls v2020.4

IF service_type = "authcode". Recid of authcode type.
service_class
no
Integer38470084
.Services API Calls v2020.4

IF service_type = "authcode". Recid of Service Class for authcode.
rating_groupnoInteger38470084.Services API Calls v2020.4
Recid of Rating Group for the Service.
Config USE_RATING_GROUP must be set to TRUE to use this field
Note: When updating a record, the "recid" or "service_id" is Required. If both are passed they must match the same record.
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
status
Available
serv_catalog
1
service_id5558675309
status_date2019/03/18
directory1
report_9111
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
service_recid
1
pools
1
Results
If the request is successful, the Recid(s) of the linking records will be returned in the same order as provided:
 Toggle cloak
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
typeREMARKS
service_recid
1
remarks
Test Remark
Results
...
Field
Required
Data Type
Options
Default
Notes
recid
no
Integer


*Conditionally Requiredif attempting to UPDATE a Service Charge
RECID for charges reads as "SERV1234" but when using that RECID for the API you only need the numbers, so "1234" from the example.
service_recid
yes
Integer


RECID column from SERVICES table.
charge_recid
yes
Integer
Services API Calls

RECID column from CHRG_CATALOG table.
description
no
String


The details or description of the charge on the Equipment
amount
no*
Decimal


The amount to be charged. *Required if charge does not have an amount on it.
TypeyesStringCHARGES

quantity
no
Integer

1
The quantity of charge to be used.
prorate
no
Integer
1 or 0
0
Should the charge be prorated when activated
gla
no
Integer38470084
.Services API Calls v2020.4

RECID of GLA to assign to Service Charge
location
no
Integer38470084
.Services API Calls v2020.4

Location that this Charge applies to for the service
start_datenoString
MRC
ARC

The Start Date of a Charge. YYYY-MM-DD format. Other formats may give unexpected results.
Used for Monthly Recurring Charges and Alternate Recurring Charges.
stop_datenoString
MRC
ARC

YYYY-MM-DD format. Other formats may give unexpected results. 
Used for Monthly Recurring Charges and Alternate Recurring Charges
recurring_datenoStringARC
YYYY-MM-DD format. Other formats may give unexpected results. 
Used for Alternate Recurring Charges
transaction_datenoStringNRC
YYYY-MM-DD format. Other formats may give unexpected results. 
Used for Non-Recurring Charges
effectivenoStringtoday, backdatetoday
Effective flag for the charge being added/stopped. if set to any value other than listed, "today" will be assumed by the API
Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use backdate as the Effective Date.
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
service_recid
1
charge_recid
1
Results
If the request is successful, the RECID of the new Service charge is returned as follows:
 Toggle cloak
...
Field
Required
Data Type
Options
Default
Notes
service_recid
yes
Integer


RECID column from SERVICES table.
gla
yes
String38470084
.Services API Calls v2020.4

Record ID(s) of the applicable GLA(s).
gla_percent
yes
String


Percentages to apply to each GLA. All percentages must equal exactly 100.
gla_type
yes
String38470084
.Services API Calls v2020.4

The type(s) of GLA(s).
Call:
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
service_recid
1
gla
1
gla_percent100
gla_typeDefault
...
Field
Required
Data Type
Options
Default
Notes
service_recid
yes
Integer


RECID column from SERVICES table.
contact
yes
String38470084
.Services API Calls v2020.4

Record ID(s) of the contact(s).
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
service_recid
1
contact
1
Results
If the request is successful, the RECID(s) of the new service contact records will be returned in the same order as provided:
 Toggle cloak
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
service_recid
1
udf_UDF-RECID1
1
udf_UDF-RECID2Test
udf_UDF-RECID32019/12/31
...
Field
Required
Data Type
Options
Default
Notes
service_recid
yes
Integer


RECID column from SERVICES table.
location
yes
Integer38470084
.Services API Calls v2020.4

Recid(s) of the Location(s) to assign to the Service.
report_911
yes
Integer
1 = yes; 0 = no

Designate if Location should show on emergency 911 feed
location_status
yes
Integer
1 = yes; 0 = no

Status of Location
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
service_recid
1
location
1
report_9111
location_status1
...
Field
Required
Data Type
Options
Default
Notes
service_recid
yes
Integer


RECID column from SERVICES table.
equipment
yes
String38470084
.Services API Calls v2020.4

Recid(s) of Equipment to assign to the Service
...
Key
Value
Content-Type
application/json
Pcr-Html-Encoded
TRUE
Body:
Key
Value
service_recid
1
equipment
1
Results
If the request is successful, the Recid of the Service Equipment record(s) will be returned in the order provided:
 Toggle cloak
...