Net3 API Interface for Customer Portal

<back to all web services

Company

Create or maintain Company records.

Requires Authentication
The following routes are available for this service:
POST/companyCreate Company Record.
PUT/company/{CompanyId}Update Company Record.
DELETE/company/{CompanyId}Delete Company Record.
GET/company/{CompanyId}Retrieve a Company Record.
TypeCompany Parameters:
NameParameterData TypeRequiredDescription
CompanyIdformGuidNo
ParentCompanyIdformstringNo
CompanyNameformstringNo
WebsiteformstringNo
CompanyNameShortformstringNo
IsResellerformboolNo
SeparateInvoiceformboolNo
TypeCompanyStatusIdformintNo
ModifiedByformGuidNo
ModifiedDateformDateTimeNo
ChannelCompaniesformList<TypeCompany>No
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 /company HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	companyId: 00000000000000000000000000000000,
	parentCompanyId: String,
	companyName: String,
	website: String,
	companyNameShort: String,
	isReseller: False,
	separateInvoice: False,
	typeCompanyStatusId: 0,
	modifiedBy: 00000000000000000000000000000000,
	modifiedDate: 0001-01-01,
	channelCompanies: 
	[
		{
			companyId: 00000000000000000000000000000000,
			parentCompanyId: String,
			companyName: String,
			website: String,
			companyNameShort: String,
			isReseller: False,
			separateInvoice: False,
			typeCompanyStatusId: 0,
			modifiedBy: 00000000000000000000000000000000,
			modifiedDate: 0001-01-01,
			channelCompanies: 
			[
				{
					companyId: 00000000000000000000000000000000,
					parentCompanyId: String,
					companyName: String,
					website: String,
					companyNameShort: String,
					isReseller: False,
					separateInvoice: False,
					typeCompanyStatusId: 0,
					modifiedBy: 00000000000000000000000000000000,
					modifiedDate: 0001-01-01,
					channelCompanies: 
					[
						{
							companyId: 00000000000000000000000000000000,
							parentCompanyId: String,
							companyName: String,
							website: String,
							companyNameShort: String,
							isReseller: False,
							separateInvoice: False,
							typeCompanyStatusId: 0,
							modifiedBy: 00000000000000000000000000000000,
							modifiedDate: 0001-01-01
						}
					]
				}
			]
		}
	]
}