Cdn API - CPG Source

<back to all web services

PhoneRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/PhoneRequest
PhoneRequest Parameters:
NameParameterData TypeRequiredDescription
IdbodylongNo
PhoneNumberbodystringNo
ExtensionbodystringNo
LabelbodystringNo
IsPrimarybodyboolNo
IsDealerDirectorybodyboolNo
IsCdnxbodyboolNo
ActivebodyboolNo
LastModbodyDateTimeNo
LastModBybodystringNo
CustomerIDbodylongNo
OrganizationIdbodylongNo
PhoneResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<PhoneDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
PhoneDto Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
PhoneNumberformstringNo
PhoneNumberDisplayformstringNo
ExtensionformstringNo
LabelformstringNo
IsPrimaryformboolNo
IsDealerDirectoryformboolNo
IsCdnxformboolNo
CustomerIDformlongNo
OrganizationIdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo

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

{
	Id: 0,
	PhoneNumber: String,
	Extension: String,
	Label: String,
	IsPrimary: False,
	IsDealerDirectory: False,
	IsCdnx: False,
	Active: False,
	LastMod: 0001-01-01,
	LastModBy: String,
	CustomerID: 0,
	OrganizationId: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			Id: 0,
			PhoneNumber: String,
			PhoneNumberDisplay: String,
			Extension: String,
			Label: String,
			IsPrimary: False,
			IsDealerDirectory: False,
			IsCdnx: False,
			CustomerID: 0,
			OrganizationId: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}