Cdn API

<back to all web services

OrganizationRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/OrganizationRequest
OrganizationRequest Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
DescriptionbodystringNo
CdnxIdbodystringNo
WebsiteUrlbodystringNo
YouTubeUrlbodystringNo
FacebookUrlbodystringNo
TwitterUrlbodystringNo
InstagramUrlbodystringNo
IndustryAffiliationsbodystringNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
OrganizationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<OrganizationDto>No
CurrentPageformintNo
TotalPagesformdecimalNo
HidePagerformboolNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
OrganizationDto Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
DescriptionformstringNo
CdnxIdformstringNo
WebsiteUrlformstringNo
YouTubeUrlformstringNo
FacebookUrlformstringNo
TwitterUrlformstringNo
InstagramUrlformstringNo
IndustryAffiliationsformstringNo
CreationDateformDateTimeNo
EmailformEmailDtoNo
AddressformAddressDtoNo
PhoneformPhoneDtoNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
EmailDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
EmailAddressformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsMailChimpUploadedformboolNo
IsOnMailChimpListformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
CustomerIDformlongNo
AddressDto Parameters:
NameParameterData TypeRequiredDescription
CountryIdformlongNo
StateIdformlongNo
LabelformstringNo
FullNameformstringNo
CompanyNameformstringNo
Address1formstringNo
Address2formstringNo
Address3formstringNo
CityformstringNo
ZipCodeformstringNo
ProvinceRegionformstringNo
IsPrimaryBillingformboolNo
IsPrimaryShippingformboolNo
IsTemporaryformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
StartDtformDateTimeNo
StartDtDisplayformstringNo
EndDtformDateTimeNo
EndDtDisplayformstringNo
CountryformCountryDtoNo
CountryNameformstringNo
StateformStateDtoNo
StateAbbrformstringNo
CountriesformIList<CountryDto>No
StatesformIList<StateDto>No
CustomerIdformlongNo
IsUspsValidformboolNo
CountryDto Parameters:
NameParameterData TypeRequiredDescription
CountryNameformstringNo
SortOrderformintNo
CountryCodeformstringNo
StateDto Parameters:
NameParameterData TypeRequiredDescription
StateNameformstringNo
AbbrformstringNo
SortOrderformint?No
IsTaxableformboolNo
IsTaxedformboolNo
UseTaxApiformboolNo
TaxRateformdecimalNo
PhoneDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PhoneNumberformstringNo
PhoneNumberDisplayformstringNo
ExtensionformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
CustomerIDformlongNo
OrganizationResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<OrganizationDto>No
CurrentPageformintNo
TotalPagesformdecimalNo
HidePagerformboolNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /OrganizationRequest HTTP/1.1 
Host: cdnapidev-cdnx.greysheet.com 
Accept: application/json
Content-Type: application/json
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: application/json
Content-Length: length

{"Data":[{"Name":"String","Description":"String","CdnxId":"String","WebsiteUrl":"String","YouTubeUrl":"String","FacebookUrl":"String","TwitterUrl":"String","InstagramUrl":"String","IndustryAffiliations":"String","CreationDate":"\/Date(-62135596800000-0000)\/","Email":{"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","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":"\/Date(-62135596800000-0000)\/","StartDtDisplay":"String","EndDt":"\/Date(-62135596800000-0000)\/","EndDtDisplay":"String","Country":{"CountryName":"String","SortOrder":0,"CountryCode":"String","Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"},"CountryName":"String","State":{"StateName":"String","Abbr":"String","SortOrder":0,"IsTaxable":false,"IsTaxed":false,"UseTaxApi":false,"TaxRate":0,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"},"StateAbbr":"String","CustomerId":0,"IsUspsValid":false,"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"},"Phone":{"Id":0,"PhoneNumber":"String","PhoneNumberDisplay":"String","Extension":"String","Label":"String","IsPrimary":false,"IsDealerDirectory":false,"IsCdnx":false,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String","CustomerID":0},"Id":0,"Active":false,"LastMod":"\/Date(-62135596800000-0000)\/","LastModBy":"String"}],"CurrentPage":0,"TotalPages":0,"HidePager":false,"Total":0,"OpCode":0,"ErrorText":"String","RequestTime":"String","ResponseTime":"String","TotalExecutionTime":"String","CachedResponse":false}