Cdn API - CPG Source

<back to all web services

XCatalogApiRoleRequest

Cdn.Api

The following routes are available for this service:
GET,POST,PUT,DELETE/XCatalogApiRoleRequest
XCatalogApiRoleRequest Parameters:
NameParameterData TypeRequiredDescription
RoleNamebodystringNo
DescriptionbodystringNo
CallsAllowedbodystringNo
BaseRequest<T> Parameters:
NameParameterData TypeRequiredDescription
Idformlong?No
OrderByformstring[]No
OrderDirectionsformSortOrders[]No
XCatalogApiRoleResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<XCatalogApiRoleDto>No
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
XCatalogApiRoleDto Parameters:
NameParameterData TypeRequiredDescription
RoleNameformstringNo
DescriptionformstringNo
CallsAllowedformstringNo
DtoBase Parameters:
NameParameterData TypeRequiredDescription
IdformlongNo
ActiveformboolNo
LastModformDateTimeNo
LastModByformstringNo
XCatalogApiRoleResponse Parameters:
NameParameterData TypeRequiredDescription
DataformList<XCatalogApiRoleDto>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 /XCatalogApiRoleRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	RoleName: String,
	Description: String,
	CallsAllowed: String,
	Id: 0,
	OrderBy: 
	[
		String
	],
	OrderDirections: 
	[
		Asc
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Data: 
	[
		{
			RoleName: String,
			Description: String,
			CallsAllowed: String,
			Id: 0,
			Active: False,
			LastMod: 0001-01-01,
			LastModBy: String
		}
	],
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}