SoftLayer Network Vlan::getObject

From SoftLayer Development Network Wiki

getObject is a member of the SoftLayer_Network_Vlan service.

Contents 1 Overview 2 Return Type 3 Headers 3.1 Required Headers 3.2 Optional Headers 4 Error Handling

Overview

getObject retrieves the SoftLayer_Network_Vlan object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_Network_Vlan service. You can only retrieve VLANs that are associated with your SoftLayer customer account.

Return Type

getObject returns the SoftLayer_Network_Vlan data type.

Headers

Required Headers

getObject requires the following headers:

• authenticate
• SoftLayer_Network_VlanInitParameters

Optional Headers

getObject may use the following headers:

• SoftLayer_Network_VlanObjectMask

Error Handling

getObject throws the following exceptions:

• SoftLayer_Exception_ObjectNotFound

Throw the error "Unable to find object with id of {id}." if the given initialization parameter has an invalid id field.

• SoftLayer_Exception_AccessDenied

Throw the error "Access Denied." if the given initialization parameter id field is not the account id of the user making the API call.