Class Transip_ColocationService

This is the API endpoint for the ColocationService

Package: Transip
Author: TransIP (support@transip.nl)
Class: ColocationService
Located at ColocationService.php

Methods summary
`public static SoapClient`	# `_getSoapClient( mixed $parameters = array() )` Gets the singleton SoapClient which is used to connect to the TransIP Api. Gets the singleton SoapClient which is used to connect to the TransIP Api. Parameters `$parameters` `mixed` $parameters Parameters. Returns `SoapClient` The SoapClient object to which we can connect to the TransIP API
`protected static string`	# `_sign( mixed $parameters )` Calculates the hash to sign our request with based on the given parameters. Calculates the hash to sign our request with based on the given parameters. Parameters `$parameters` `mixed` $parameters The parameters to sign. Returns `string` Base64 encoded signing hash.
`protected static string`	# `_sha512Asn1( string $data )` Creates a digest of the given data, with an asn1 header. Creates a digest of the given data, with an asn1 header. Parameters `$data` `string` $data The data to create a digest of. Returns `string` The digest of the data, with asn1 header.
`protected static string`	# `_encodeParameters( mixed $parameters, string $keyPrefix = null )` Encodes the given paramaters into a url encoded string based upon RFC 3986. Encodes the given paramaters into a url encoded string based upon RFC 3986. Parameters `$parameters` `mixed` $parameters The parameters to encode. `$keyPrefix` `string` $keyPrefix Key prefix. Returns `string` The given parameters encoded according to RFC 3986.
`protected static string`	# `_urlencode( string $string )` Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed. Our own function to encode a string according to RFC 3986 since. PHP < 5.3.0 encodes the ~ character which is not allowed. Parameters `$string` `string` $string The string to encode. Returns `string` The encoded string according to RFC 3986.
`public static Transip_DataCenterVisitor[]`	# `requestAccess( string $when, integer $duration, string[] $visitors, string $phoneNumber )` Requests access to the data-center Requests access to the data-center Parameters `$when` `string` $when the datetime of the wanted datacenter access, in YYYY-MM-DD hh:mm:ss format `$duration` `integer` $duration the expected duration of the visit, in minutes `$visitors` `string[]` $visitors the names of the visitors for this data-center visit, must be at least 1 and at most 20 `$phoneNumber` `string` $phoneNumber if an SMS with access codes needs to be sent, set the phonenumber of the receiving phone here; Returns `Transip_DataCenterVisitor[]` An array of Visitor objects holding information (such as reservation and access number) about Throws `ApiException`
`public static`	# `requestRemoteHands( string $coloName, string $contactName, string $phoneNumber, integer $expectedDuration, string $instructions )` Request remote hands to the data-center Request remote hands to the data-center Parameters `$coloName` `string` $coloName The name of the colocation `$contactName` `string` $contactName The contact name `$phoneNumber` `string` $phoneNumber Phone number to contact `$expectedDuration` `integer` $expectedDuration Expected duration of the job in minutes `$instructions` `string` $instructions What to do Throws `ApiException`
`public static string[]`	# `getColoNames( )` Get coloNames for customer Get coloNames for customer Returns `string[]` Array with colo names
`public static string[]`	# `getIpAddresses( string $coloName )` Get IpAddresses that are active and assigned to a Colo. Both ipv4 and ipv6 addresses are returned: ipv4 adresses in dot notation, ipv6 addresses in ipv6 presentation. Get IpAddresses that are active and assigned to a Colo. Both ipv4 and ipv6 addresses are returned: ipv4 adresses in dot notation, ipv6 addresses in ipv6 presentation. Parameters `$coloName` `string` $coloName The name of the colo to get the ipaddresses for for Returns `string[]` Array with assigned IPv4 and IPv6 addresses for the colo
`public static string[]`	# `getIpRanges( string $coloName )` Get ipranges that are assigned to a Colo. Both ipv4 and ipv6 ranges are returned, in CIDR notation. Get ipranges that are assigned to a Colo. Both ipv4 and ipv6 ranges are returned, in CIDR notation. Parameters `$coloName` `string` $coloName The name of the colo to get the ranges for Returns `string[]` Array of ipranges in CIDR format assigned to this colo. See http://en.wikipedia.org/wiki/CIDR_notation
`public static`	# `createIpAddress( string $ipAddress, string $reverseDns )` Adds a new IpAddress, either an ipv6 or an ipv4 address. The service will validate the address, ensure the user is entitled to the address and will add the address to the correct Colo and range. Adds a new IpAddress, either an ipv6 or an ipv4 address. The service will validate the address, ensure the user is entitled to the address and will add the address to the correct Colo and range. Parameters `$ipAddress` `string` $ipAddress The IpAddress to create, can be either ipv4 or ipv6. `$reverseDns` `string` $reverseDns The RDNS name for this IpAddress Throws `ApiException`
`public static`	# `deleteIpAddress( string $ipAddress )` Deletes an IpAddress currently in use this account. IpAddress can be either ipv4 or ipv6. The service will validate if the user has rights to remove the address and will remove it completely, together with any RDNS or monitoring assigned to the address. Deletes an IpAddress currently in use this account. IpAddress can be either ipv4 or ipv6. The service will validate if the user has rights to remove the address and will remove it completely, together with any RDNS or monitoring assigned to the address. Parameters `$ipAddress` `string` $ipAddress the IpAddress to delete, can be either ipv4 or ipv6.
`public static string`	# `getReverseDns( string $ipAddress )` Get the Reverse DNS for an IpAddress assigned to the user Throws an Exception when the Address does not exist or is not owned by the user. Get the Reverse DNS for an IpAddress assigned to the user Throws an Exception when the Address does not exist or is not owned by the user. Parameters `$ipAddress` `string` $ipAddress the IpAddress, either ipv4 or ipv6 Returns `string` rdns
`public static`	# `setReverseDns( string $ipAddress, string $reverseDns )` Set the RDNS name for an ipAddress. Throws an Exception when the Address does not exist or is not owned by the user. Set the RDNS name for an ipAddress. Throws an Exception when the Address does not exist or is not owned by the user. Parameters `$ipAddress` `string` $ipAddress The IpAddress to set the reverse dns for, can be either ipv4 or ipv6. `$reverseDns` `string` $reverseDns The new reverse DNS, must be a valid RDNS value.

Constants summary
`string`	`SERVICE`	`'ColocationService'`	# The SOAP service that corresponds with this class. The SOAP service that corresponds with this class.
`string`	`API_VERSION`	`'5.23'`	# The API version. The API version.
`string`	`TRACK_ENDPOINT_NAME`	`'Colocation'`	#

Properties summary
`protected static SoapClient`	`$_soapClient`	`null`	# The SoapClient used to perform the SOAP calls. The SoapClient used to perform the SOAP calls.