Net3 API Interface for Customer Portal

<back to all web services

ScheduledHosts

Requires Authentication
The following routes are available for this service:
GET/schedules/hosts/{companyId}
GET/schedules/hosts/{companyId}/{scheduleId}
ScheduledHosts Parameters:
NameParameterData TypeRequiredDescription
scheduleIdpathGuidNo
ScheduleBase Parameters:
NameParameterData TypeRequiredDescription
companyIdformGuidNo
userIdformGuidNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
ScheduledHostsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TypeScheduledHosts>No
ResponseStatusformResponseStatusNo
TypeScheduledHosts Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
ScheduleIdformGuidNo
HostIdformstringNo
HostNameformstringNo
HostDatacenterCodeformstringNo
HostLocationIdformGuidNo
PrecedenceformintNo
DelayStartformintNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /schedules/hosts/{companyId} HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			id: 00000000000000000000000000000000,
			scheduleId: 00000000000000000000000000000000,
			hostId: String,
			hostName: String,
			hostDatacenterCode: String,
			hostLocationId: 00000000000000000000000000000000,
			precedence: 0,
			delayStart: 0
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}