Net3 API Interface for Customer Portal

<back to all web services

Companies

Retrieve Company information.

Requires Authentication
The following routes are available for this service:
POST/companiesOLD
Companies Parameters:
NameParameterData TypeRequiredDescription
secretbodystringNo
DTOBase Parameters:
NameParameterData TypeRequiredDescription
sessionIdformstringNo
CompaniesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TypeCompany>No
ResponseStatusformResponseStatusNo
TypeCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
CompanyNameformstringNo
WebsiteformstringNo
CompanyNameShortformstringNo
IsResellerformboolNo
TypeCompanyStatusIdformintNo
ModifiedByformGuidNo
ModifiedDateformDateTimeNo

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 /companiesOLD HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	secret: String,
	sessionId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			companyId: 00000000000000000000000000000000,
			companyName: String,
			website: String,
			companyNameShort: String,
			isReseller: False,
			typeCompanyStatusId: 0,
			modifiedBy: 00000000000000000000000000000000,
			modifiedDate: 0001-01-01
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}