...
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
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <services>
<status>success</status>
<page>1</page>
<count>20</count>
<total_count>1331</total_count>
<services>
<item>
<RECID>2488</RECID>
<MODIFIED_DATE>2014-08-22 12:37:49</MODIFIED_DATE>
<BILLABLE>Yes</BILLABLE>
<STATUS_DATE>2014-07-11 15:35:38</STATUS_DATE>
<CAT_RECID>46</CAT_RECID>
<SERVICE_HOST/>
<SERVICE_ID>5555555555</SERVICE_ID>
<SERVICE_ID_FMT>(555) 555-5555</SERVICE_ID_FMT>
<CATALOG>Amazing Product</CATALOG>
<OWNER>Blue Alert</OWNER>
<MODIFIED_BY>PCR User</MODIFIED_BY>
<LOCATIONS_PATH/>
<SLA_CATALOG_PATH/>
<S_SERVICE_STATUS_VALUE>Active</S_SERVICE_STATUS_VALUE>
<SERVICE_STATUS>ACTIVE</SERVICE_STATUS>
<SERVICES_UDF>
<item>
<LABEL>Label</LABEL>
<VALUE>value</VALUE>
</item>
</SERVICES_UDF>
<SERVICES_CHARGES>
<item>
<RECID>956</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2014-07-21 14:55:11</MODIFIED_DATE>
<MODIFIED_BY>PCR User</MODIFIED_BY>
<SERVICES_RECID>29</SERVICES_RECID>
<CHRG_CATALOG_RECID>57</CHRG_CATALOG_RECID>
<DESCRIPTION/>
<AMOUNT>50</AMOUNT>
<BILL_DATE/>
<PRORATE>0</PRORATE>
<EXPENSE_GLA_RECID/>
<QUANTITY/>
<CATALOG_NAME>name</CATALOG_NAME>
<CATALOG_DESCRIPTION>description</CATALOG_DESCRIPTION>
<CATALOG_AMOUNT>199</CATALOG_AMOUNT>
</item>
</SERVICES_CHARGES>
<SERVICES_CONTACTS>
<item>
<RECID>2523</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2013-06-05 10:25:56</MODIFIED_DATE>
<MODIFIED_BY>PCR User</MODIFIED_BY>
<SERVICES_RECID>1767</SERVICES_RECID>
<CONTACTS_RECID>34</CONTACTS_RECID>
<FIRST_NAME>John</FIRST_NAME>
<LAST_NAME>Doe</LAST_NAME>
</item>
</SERVICES_CONTACTS>
<SERVICES_EQUIPMENT>
<item>
<RECID>71</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2015-03-26 13:38:34</MODIFIED_DATE>
<MODIFIED_BY>PCR User</MODIFIED_BY>
<SERVICES_RECID>1697</SERVICES_RECID>
<EQUIPMENT_RECID>3078</EQUIPMENT_RECID>
<SERVICE_ID>0000001234</SERVICE_ID>
<SERV_CATALOG_RECID>56</SERV_CATALOG_RECID>
<OWNER_CONTACTS_RECID/>
<OWNER_DEPT_HIERARCHY_RECID>47</OWNER_DEPT_HIERARCHY_RECID>
<BILLABLE>No</BILLABLE>
<SERVICE_STATUS_LISTS_RECID>1321</SERVICE_STATUS_LISTS_RECID>
<STATUS_DATE>2015-03-10 13:24:27</STATUS_DATE>
<SERVICE_HOSTS_RECID>26</SERVICE_HOSTS_RECID>
<SLA_CATALOG_RECID/>
<LOCATIONS_RECID>66</LOCATIONS_RECID>
<REFERENCE/>
<ESSENTIAL>0</ESSENTIAL>
<BILLING_GROUPS_RECID/>
<SERVICE_ID_FMT>(000) 000-1234</SERVICE_ID_FMT>
<EQP_STATUS_LISTS_RECID>1175</EQP_STATUS_LISTS_RECID>
<EQP_CATALOG_RECID>71</EQP_CATALOG_RECID>
<SERIAL_NUM>006A</SERIAL_NUM>
<SERIAL_NUM_BARCODE/>
<EQUIPMENT_ID>006A</EQUIPMENT_ID>
<ASSET_TAG/>
<CONSUMED>No</CONSUMED>
<PURCHASE_PRICE/>
<RECEIVED_DATE/>
<BILLED_DATE/>
<CARD_NUMBER/>
<PARENT_EQUIPMENT_RECID/>
<CABLING_EQP_TYPE_LISTS_RECID/>
<IP4_GATEWAY/>
<IP6_GATEWAY/>
<LAN_NAME/>
<MAC_ADDRESS/>
<IP4_ADDRESS/>
<IP6_ADDRESS/>
<IP4_SUBNET_MASK/>
<IP6_SUBNET_MASK/>
<IP4_GATEWAY_ADDRESS/>
<IP6_GATEWAY_ADDRESS/>
<HOST_NAME/>
<EQP_CONDITION_LISTS_RECID/>
<ORDERED_DATE/>
<UNITS/>
<WARRANTY_END_DATE/>
<USE_DHCP>0</USE_DHCP>
<PRIVATE>0</PRIVATE>
<STATUS>Active</STATUS>
<PART_NUMBER>ABC123</PART_NUMBER>
<PART_NUM_BARCODE/>
<DESCRIPTION>ABC123</DESCRIPTION>
<MANUFACTURER/>
<MANU_PART_NUM/>
<CATALOG_DESCRIPTION/>
<CATEGORY>No</CATEGORY>
<PRORATE>No</PRORATE>
<ASSIGNABLE>No</ASSIGNABLE>
<CABLING_EQUIPMENT>Yes</CABLING_EQUIPMENT>
<ASSET>No</ASSET>
<LOCATION_REQUIRED>No</LOCATION_REQUIRED>
<ORDERABLE>0</ORDERABLE>
<CONSUMABLE>No</CONSUMABLE>
<PROVISIONED>0</PROVISIONED>
<REVENUE_GLA_RECID>45</REVENUE_GLA_RECID>
<REVENUE_OB_CODES_RECID>6</REVENUE_OB_CODES_RECID>
<EXPENSE_OB_CODES_RECID>6</EXPENSE_OB_CODES_RECID>
<WORKER_INSTALL_TIME>3600</WORKER_INSTALL_TIME>
<WORKER_REMOVE_TIME>3600</WORKER_REMOVE_TIME>
<MAX_QUANTITY/>
<PARENT_EQP_CATALOG_RECID/>
<WARRANTY_LENGTH_LISTS_RECID/>
<HEIGHT/>
<WIDTH/>
<SLOTS/>
<UNIT_LISTS_RECID>1342</UNIT_LISTS_RECID>
<HAS_UNITS>0</HAS_UNITS>
<CONTIGUOUS>0</CONTIGUOUS>
</item>
</SERVICES_EQUIPMENT>
<SERVICES_EXPENSE_GLA>
<item>
<PERCENT>100</PERCENT>
<Type>Default</Type>
<GLA_FULL_CODES_0>100 > 200 > 300 > 400</GLA_FULL_CODES_0>
</item>
</SERVICES_EXPENSE_GLA>
<SERVICES_REMARKS>
<item>
<RECID>74</RECID>
<TENANTS_RECID>0</TENANTS_RECID>
<MODIFIED_DATE>2013-07-05 14:04:51</MODIFIED_DATE>
<MODIFIED_BY>PCR User</MODIFIED_BY>
<SERVICES_RECID>1697</SERVICES_RECID>
<REMARKS>These are the remarks</REMARKS>
</item>
</SERVICES_REMARKS>
</item>
</services>
</services> |
|
...
Type | Description | Extra Parameters* | Searchable | Results |
---|
CONTACTS | Retrieve available Contacts | CTYPE - Type of contact. Example: "worker" | yes | Contacts Results
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <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
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <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
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <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
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <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
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <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
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
| <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
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| <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> |
|
|
...
Field | Required | Data Type | Options | Default | Notes |
---|
recid | no* | Integer |
|
| Identifier of the record. *See Note Below |
status | yes | Integer | (2024.1) Services API Calls91980168 |
| The status of the service. |
serv_catalog | yes | Integer | (2024.1) Services API Calls91980168 |
| Recid of the Service Catalog item. Insert excerpt |
---|
| (2024.1) Bulk Update |
---|
| (2024.1) Bulk Update |
---|
nopanel | true |
---|
|
|
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* | Integer | (2024.1) Services API Calls91980168 |
| Record ID of either the Contact or the Department owner. The API will validate if the Owner's GLA Format is compatible with the Service's Billing Group Format. |
owner_type | no* | String | "contact" or "department" |
| Type of owner |
location | no | Integer | (2024.1) Services API Calls91980168 |
| Recid of location for service. |
service_host | no | Integer | (2024.1) Services API Calls91980168 |
| Recid of Service Host for service. |
sla | no | Integer | (2024.1) Services API Calls91980168 |
| 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 | Integer | (2024.1) Services API Calls91980168 |
| 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 | Integer | (2024.1) Services API Calls91980168 |
| Recid of Associated Service. |
equipment | no | String | (2024.1) Services API Calls91980168 |
| Recid(s) of equipment to add to Service. If multiple Equipment are to be assigned, separate Recids with commas. Example: 56,875. |
contact | no | String | (2024.1) Services API Calls91980168 |
| 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 | String | (2024.1) Services API Calls91980168 |
| 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 | Integer | (2024.1) Services API Calls91980168 |
| 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. The Override GLA Format should match the Billing Group Format of the Service, |
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* | String | (2024.1) Services API Calls91980168 |
| 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 | Integer | (2024.1) Services API Calls91980168 |
| IF service_type = "data" OR "backbone". Recid of bandwidth record. |
auth_code_type | no | Integer | (2024.1) Services API Calls91980168 |
| IF service_type = "authcode". Recid of authcode type. |
service_class | no | Integer | (2024.1) Services API Calls91980168 |
| IF service_type = "authcode". Recid of Service Class for authcode. |
rating_group | no | Integer | (2024.1) Services API Calls91980168 |
| 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_id | 5558675309 |
status_date | 2019/03/18 |
directory | 1 |
report_911 | 1 |
...
If the request is successful, the Service RECID will be returned as follows:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "0",
"service": 54875
} |
|
...
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:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "0",
"services": [
{
"item": 2312,
"item": 2313
}
]
} |
|
...
Key | Value |
---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|
type | REMARKS |
service_recid | 1 |
remarks | Test Remark |
Results
If the request is successful, the Recid of the remark record will be returned as follows:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "0",
"services": 456231
} |
|
...
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 | no* | Integer | Services API Calls |
| RECID column from CHRG_CATALOG table. *Conditionally Required if attempting to add a new Service Charge |
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. |
type | yes | String | CHARGES |
|
|
quantity | no | Integer |
| 1 | The quantity of Charge to be used. Only allowed if Charge Catalog allows it. |
prorate | no | Integer | 1 or 0 | 0 | Should the charge be prorated when activated. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false |
gla | no | Integer | (2024.1) Services API Calls91980168 |
| RECID of GLA to assign to Service Charge |
location | no | Integer | (2024.1) Services API Calls91980168 |
| Location that this Charge applies to for the service |
start_date | no | String | 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_date | no | String | MRC ARC |
| YYYY-MM-DD format. Other formats may give unexpected results.
Used for Monthly Recurring Charges and Alternate Recurring Charges |
recurring_date | no | String | ARC |
| YYYY-MM-DD format. Other formats may give unexpected results.
Used for Alternate Recurring Charges |
transaction_date | no | String | NRC |
| YYYY-MM-DD format. Other formats may give unexpected results.
Used for Non-Recurring Charges |
effective | no | String | today, backdate | today | 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:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "1",
"services": 58337
} |
|
...
When adding a new GLA to a Service, the API will validate that the Billing Group Format for the Service is compatible with the Format for the new GLA.
...
Key | Value |
---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|
service_recid | 1 |
gla | 1 |
gla_percent | 100 |
gla_type | Default |
...
If the request is successful, the RECID(s) of the new Service GLA records will be returned in the same order as provided:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "1",
"services": [
{
"item": 234,
"item": 235
}
]
} |
|
...
Field | Required | Data Type | Options | Default | Notes |
---|
service_recid | yes | Integer |
|
| RECID column from SERVICES table. |
contact | yes | String | (2024.1) Services API Calls91980168 |
| 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:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "1",
"services": [
{
"item": 123,
"item": 124
}
]
} |
|
...
Key | Value |
---|
Content-Type | application/json |
Pcr-Html-Encoded | TRUE |
Body:
Key | Value |
---|
service_recid | 1 |
udf_UDF-RECID1 | 1 |
udf_UDF-RECID2 | Test |
udf_UDF-RECID3 | 2019/12/31 |
...
If the request is successful, the RECID(s) of the new Service UDF records will be returned in the same order as provided:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "1",
"services": [
{
"item": 5434,
"item": 5435
}
]
} |
|
...
Field | Required | Data Type | Options | Default | Notes |
---|
service_recid | yes | Integer |
|
| RECID column from SERVICES table. |
location | yes | Integer | (2024.1) Services API Calls91980168 |
| 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_911 | 1 |
location_status | 1 |
...
If the request is successful, the Recid of the Service Location record(s) will be returned in the same order as provided:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "0",
"services": [
{
"item": 4545,
"item": 4546
}
]
} |
|
...
Field | Required | Data Type | Options | Default | Notes |
---|
service_recid | yes | Integer |
|
| RECID column from SERVICES table. |
equipment | yes | String | (2024.1) Services API Calls91980168 |
| 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:
Cloak |
---|
Code Block |
---|
language | xml |
---|
linenumbers | true |
---|
| {
"status": "success",
"page": 1,
"count": 1,
"total_count": "0",
"services": [
{
"item": 234.
"item": 235
}
]
} |
|
...