Calling saveEquipment using Equipment API Parameters

type

• Data Type: String

• Required Field: No

Notes:

“VLAN”, “REMARK”, “CHARGES”, “GLA”, “CONTACTS”, “UDF”, “ATTACHMENT”

recid

• Data Type: Integer

• Required Field: Yes*

• Required Type: none, “CHARGES”, “ATTACHMENT”

Notes:

The recid of the Equipment, when type is not “CHARGES:, when type = “CHARGES”, this is the recid of the Charge being updated.

*If adding a new Charge when type = “CHARGES”, this field is not used.

status

• Data Type: Integer

• Required Field: Yes

• Required Type: none

Notes:

The recid of the status of the Equipment, as defined by the LISTS table for Equipment Status.

eqp_catalog

• Data Type: Integer

• Required Field: Yes

• Required Type: none

Notes:

Recid of the Equipment Catalog item

location

• Data Type: Integer

• Required Field: No

• Required Type: none

Notes:

The recid of the Location

owner

• Data Type: Integer

• Required Field: No*

• Required Type: none

Notes:

The recid of either the Contact or the Department Owner
*Conditionally Required for updating

owner_type

• Data Type: String

• Required Field: No*

• Required Type: none

Notes:

Type of Owner.
*Conditionally Required only when setting an Owner

serial_number

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Serial number of Equipment

serial_number_barcode

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Serial number barcode of Equipment

equipment_id

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

ID of Equipment

asset_tag

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Asset tag of the Equipment

billable

• Data Type: Integer

• Required Field: Yes

• Required Type: none

Notes:

Designate if the Equipment is Billable. “1” for Yes, “0” for No.

consumed

• Data Type: Integer

• Required Field: Yes

• Required Type: none

Notes:

Designate if the Equipment is consumed. “1” for Yes, “0” for No.

purchase_price

• Data Type: Decimal

• Required Field: No

• Required Type: none

Notes:

Purchase price of the Equipment

received_date

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Date Equipment was received

billed_date

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Date Equipment was billed

card_number

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Card number of Equipment

parent_equipment

• Data Type: Integer

• Required Field: No

• Required Type: none

Notes:

Recid of parent Equipment, if applicable

cabling_equipment_type

• Data Type: Integer

• Required Field: No

• Required Type: none

Notes:

Recid of Cabling Equipment type from the LISTs table for Cabling Equipment Types.

ip4_gateway

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv4 address of gateway for Equipment

ip6_gateway

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv6 address of gateway for Equipment

lan_name

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Name of LAN Equipment is attached to

mac

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

MAC address of Equipment

ip4

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv4 address of Equipment

ip6

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv6 address of Equipment

ip4_subnet

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv4 address for subnet that Equipment is attached to

ip6_subnet

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv6 address for subnet that Equipment is attached to

ip4_gateway_address

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv4 address of gateway

ip6_gateway_address

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

IPv6 address of gateway

host_name

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Host name of Equipment

condition

• Data Type: Integer

• Required Field: No

• Required Type: none

Notes:

The recid of the condition for Equipment, as defined by the LISTS table for Equipment Condition.

ordered_date

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Date Equipment was ordered

units

• Data Type: Integer

• Required Field: No

• Required Type: none

Notes:

Quantity on hand

warranty_end_date

• Data Type: String

• Required Field: No

• Required Type: none

Notes:

Date that warranty ends on Equipment. warranty_end_date is automatically set when received_date is provided

use_dhcp

• Data Type: Integer

• Required Field: Yes

• Required Type: none

Notes:

Designate if the Equipment uses DHCP. “1” for Yes, “0” for No.

private

• Data Type: Integer

• Required Field: Yes

• Required Type: none

Notes:

Designate if this Equipment is private. “1” for Yes, “0” for No.

vlan

• Data Type: String

• Required Field: Yes

• Required Type: “VLAN”

Notes:

One or more Recids of VLANs. If multiple, separate with commas. Example: 23,43

contact

• Data Type: String

• Required Field: Yes

• Required Type: “CONTACTS”

Notes:

The recid(s) of the Contact(s).

remarks

• Data Type: String

• Required Field: Yes

• Required Type: “REMARK”

Notes:

The remark to add to the Equipment.

gla

• Data Type: String

• Required Field: Yes

• Required Type: “GLA”

Notes:

The recid(s) of the GLA(s)

gla_percent

• Data Type: String

• Required Field: Yes

• Required Type: “GLA”

Notes:

Percentages to apply to each GLA. All percentages must equal exactly 100.

gla_type

• Data Type: String

• Required Field: Yes

• Required Type: “GLA”

Notes:

The type(s) of GLA(s) from the GLA Types LISTS Values.

equipment_recid

• Data Type: Integer

• Required Field: Yes

• Required Type: “VLAN”, “REMARK”, “CHARGES”, “GLA”, “CONTACTS”, “UDF”

• Default Value:

Notes:

The recid of the Equipment.

charge_recid

• Data Type: Integer

• Required Field: Yes

• Required Type: “CHARGES”

Notes:

The recid of the applicable Charge Catalog.

description

• Data Type: String

• Required Field: No

• Required Type: “CHARGES”

Notes:

The details or Description of the Charge on the Equipment

amount

• Data Type: Decimal

• Required Field: No*

• Required Type: “CHARGES”

Notes:

The amount to be charged.

*Conditionally Required if charge does not have an amount on it.

quantity

• Data Type: Integer

• Required Field: No

• Required Type: “CHARGES”

• Default Value: 1

Notes:

Quantity of Charge to be used. Only allowed if Charge Catalog allows it.

prorate

• Data Type: Integer

• Required Field: No

• Required Type: “CHARGES”

• Default Value: 0

Notes:

Should the Charge be prorated when activated. Only allowed if BILL_MRC_CHANGE_FORCE_PRORATE config option is false. “1” for Yes, “0” for No.

start_date

• Data Type: String

• Required Field: No

• Required Type: “CHARGES”

Notes:

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

• Data Type: String

• Required Field: No

• Required Type: “CHARGES”

Notes:

YYYY-MM-DD format. Other formats may give unexpected results.

Used for Monthly Recurring Charges and Alternate Recurring Charges

recurring_date

• Data Type: String

• Required Field: No

• Required Type: “CHARGES”

Notes:

YYYY-MM-DD format. Other formats may give unexpected results.

Used for Alternate Recurring Charges

transaction_date

• Data Type: String

• Required Field: No

• Required Type: “CHARGES”

Notes:

YYYY-MM-DD format. Other formats may give unexpected results.

Used for Non-Recurring Charges

override_amount

• Data Type: Decimal

• Required Field: No

• Required Type: “CHARGES”

Notes:

If allowed by the selected Charge, overrides the default amount from the Charge.

override_gla

• Data Type: Integer

• Required Field: No

• Required Type: “CHARGES”

Notes:

The recid of the GLA to override default GLA with. The Override GLA Format should match the Billing Group Format of the Equipment.

effective

• Data Type: String

• Required Field: No

• Required Type: “CHARGES”

• Default Value: “today”

Notes:

Effective flag for the Charge being added/stopped. “today” or “backdate”.

Alternate Recurring Charges (Quarterly, Semi-Annual and Annual), when updated will always use backdate as the Effective Date.

udf_UDF-RECID

• Data Type: Integer

• Required Field: Yes*

• Required Type: “UDF”

Notes:

UDF-RECID is the RECID of the UDF to assign the value to. Example: udf_684=value

*udf_UDF-RECID and udf_UDF-IDENTIFIER are Conditionally Required. The use of one is Required, but not both.

udf_UDF-IDENTIFIER

• Data Type: String

• Required Field: Yes*

• Required Type: “UDF”

Notes:

• IDENTIFIER is the unique Identifier of the UDF to assign the value to. Example: udf_LEGACYNUM=value

  *udf_UDF-RECID and udf_UDF-IDENTIFIER are Conditionally Required. The use of one is Required, but not both.

filename

• Data Type: String

• Required Field: Yes

• Required Type: “ATTACHMENT”

Notes:

the file name

data

• Data Type: Array

• Required Field: Yes

• Required Type: “ATTACHMENT”

Notes:

the base64 encoded data for the file