Net3 API Interface for Customer Portal

<back to all web services

FindLocations

Requires Authentication
The following routes are available for this service:
All Verbs/logins/locations/find
FindLocations Parameters:
NameParameterData TypeRequiredDescription
locationquerystringNo
QueryBase Parameters:
NameParameterData TypeRequiredDescription
Skipformint?No
Takeformint?No
OrderByformstringNo
OrderByDescformstringNo
IncludeformstringNo
FieldsformstringNo
MetaformDictionary<string, string>No
Locations Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
LocationIdformGuidNo
ApplicationIdformGuidNo
LocationformstringNo
LocationTypeformGuidNo
DatacenterIdformGuidNo
EntityBase Parameters:
NameParameterData TypeRequiredDescription
IdformGuidNo
QueryResponse<T> Parameters:
NameParameterData TypeRequiredDescription
OffsetformintNo
TotalformintNo
ResultsformList<T>No
MetaformDictionary<string, string>No
ResponseStatusformResponseStatusNo

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.

POST /logins/locations/find HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	location: String,
	skip: 0,
	take: 0,
	orderBy: String,
	orderByDesc: String,
	include: String,
	fields: String,
	meta: 
	{
		String: String
	}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			id: 00000000000000000000000000000000,
			locationId: 00000000000000000000000000000000,
			applicationId: 00000000000000000000000000000000,
			location: String,
			locationType: 00000000000000000000000000000000,
			datacenterId: 00000000000000000000000000000000
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}