Cdn API

OrganizationRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE	/OrganizationRequest

**OrganizationRequest** Parameters:
Name	Parameter	Data Type	Required
Name	body	string	No
Description	body	string	No
CdnxId	body	string	No
WebsiteUrl	body	string	No
YouTubeUrl	body	string	No
FacebookUrl	body	string	No
TwitterUrl	body	string	No
InstagramUrl	body	string	No
IndustryAffiliations	body	string	No

**BaseRequest<T>** Parameters:
Name	Parameter	Data Type	Required
Id	form	long?	No
OrderBy	form	string[]	No
OrderDirections	form	SortOrders[]	No

**OrganizationResponse** Parameters:
Name	Parameter	Data Type	Required
Data	form	List<OrganizationDto>	No
CurrentPage	form	int	No
TotalPages	form	decimal	No
HidePager	form	bool	No

**BaseResponse** Parameters:
Name	Parameter	Data Type	Required
Total	form	int	No
OpCode	form	int	No
ErrorText	form	string	No
RequestTime	form	string	No
ResponseTime	form	string	No
TotalExecutionTime	form	string	No
CachedResponse	form	bool	No

**OrganizationDto** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Description	form	string	No
CdnxId	form	string	No
WebsiteUrl	form	string	No
YouTubeUrl	form	string	No
FacebookUrl	form	string	No
TwitterUrl	form	string	No
InstagramUrl	form	string	No
IndustryAffiliations	form	string	No
CreationDate	form	DateTime	No
Email	form	EmailDto	No
Address	form	AddressDto	No
Phone	form	PhoneDto	No

**DtoBase** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No

**EmailDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No
EmailAddress	form	string	No
Label	form	string	No
IsPrimary	form	bool	No
IsMailChimpUploaded	form	bool	No
IsOnMailChimpList	form	bool	No
IsDealerDirectory	form	bool	No
IsCdnx	form	bool	No
CustomerID	form	long	No

**AddressDto** Parameters:
Name	Parameter	Data Type	Required
CountryId	form	long	No
StateId	form	long	No
Label	form	string	No
FullName	form	string	No
CompanyName	form	string	No
Address1	form	string	No
Address2	form	string	No
Address3	form	string	No
City	form	string	No
ZipCode	form	string	No
ProvinceRegion	form	string	No
IsPrimaryBilling	form	bool	No
IsPrimaryShipping	form	bool	No
IsTemporary	form	bool	No
IsDealerDirectory	form	bool	No
IsCdnx	form	bool	No
StartDt	form	DateTime	No
StartDtDisplay	form	string	No
EndDt	form	DateTime	No
EndDtDisplay	form	string	No
Country	form	CountryDto	No
CountryName	form	string	No
State	form	StateDto	No
StateAbbr	form	string	No
Countries	form	IList<CountryDto>	No
States	form	IList<StateDto>	No
CustomerId	form	long	No
IsUspsValid	form	bool	No

**CountryDto** Parameters:
Name	Parameter	Data Type	Required
CountryName	form	string	No
SortOrder	form	int	No
CountryCode	form	string	No

**StateDto** Parameters:
Name	Parameter	Data Type	Required
StateName	form	string	No
Abbr	form	string	No
SortOrder	form	int?	No
IsTaxable	form	bool	No
IsTaxed	form	bool	No
UseTaxApi	form	bool	No
TaxRate	form	decimal	No

**PhoneDto** Parameters:
Name	Parameter	Data Type	Required
Id	form	long	No
PhoneNumber	form	string	No
PhoneNumberDisplay	form	string	No
Extension	form	string	No
Label	form	string	No
IsPrimary	form	bool	No
IsDealerDirectory	form	bool	No
IsCdnx	form	bool	No
Active	form	bool	No
LastMod	form	DateTime	No
LastModBy	form	string	No
CustomerID	form	long	No

**OrganizationResponse** Parameters:
Name	Parameter	Data Type	Required
Data	form	List<OrganizationDto>	No
CurrentPage	form	int	No
TotalPages	form	decimal	No
HidePager	form	bool	No

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 /OrganizationRequest HTTP/1.1 
Host: cdnapibeta-cdnx.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	Description: String,
	CdnxId: String,
	WebsiteUrl: String,
	YouTubeUrl: String,
	FacebookUrl: String,
	TwitterUrl: String,
	InstagramUrl: String,
	IndustryAffiliations: String,
	Id: 0,
	OrderBy: 
	[
		String
	],
	OrderDirections: 
	[
		Asc
	]
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			Name: String,
			Description: String,
			CdnxId: String,
			WebsiteUrl: String,
			YouTubeUrl: String,
			FacebookUrl: String,
			TwitterUrl: String,
			InstagramUrl: String,
			IndustryAffiliations: String,
			CreationDate: 0001-01-01,
			Email: 
			{
				Id: 0,
				Active: False,
				LastMod: 0001-01-01,
				LastModBy: String,
				EmailAddress: String,
				Label: String,
				IsPrimary: False,
				IsMailChimpUploaded: False,
				IsOnMailChimpList: False,
				IsDealerDirectory: False,
				IsCdnx: False,
				CustomerID: 0
			},
			Address: 
			{
				CountryId: 0,
				StateId: 0,
				Label: String,
				FullName: String,
				CompanyName: String,
				Address1: String,
				Address2: String,
				Address3: String,
				City: String,
				ZipCode: String,
				ProvinceRegion: String,
				IsPrimaryBilling: False,
				IsPrimaryShipping: False,
				IsTemporary: False,
				IsDealerDirectory: False,
				IsCdnx: False,
				StartDt: 0001-01-01,
				StartDtDisplay: String,
				EndDt: 0001-01-01,
				EndDtDisplay: String,
				Country: 
				{
					CountryName: String,
					SortOrder: 0,
					CountryCode: String,
					Id: 0,
					Active: False,
					LastMod: 0001-01-01,
					LastModBy: String
				},
				CountryName: String,
				State: 
				{
					StateName: String,
					Abbr: String,
					SortOrder: 0,
					IsTaxable: False,
					IsTaxed: False,
					UseTaxApi: False,
					TaxRate: 0,
					Id: 0,
					Active: False,
					LastMod: 0001-01-01,
					LastModBy: String
				},
				StateAbbr: String,
				CustomerId: 0,
				IsUspsValid: False,
				Id: 0,
				Active: False,
				LastMod: 0001-01-01,
				LastModBy: String
			},
			Phone: 
			{
				Id: 0,
				PhoneNumber: String,
				PhoneNumberDisplay: String,
				Extension: String,
				Label: String,
				IsPrimary: False,
				IsDealerDirectory: False,
				IsCdnx: False,
				Active: False,
				LastMod: 0001-01-01,
				LastModBy: String,
				CustomerID: 0
			},
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	CurrentPage: 0,
	TotalPages: 0,
	HidePager: False,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}