Cdn API - CPG Source

<back to all web services

IapOfferingCreateRequest

Cdn.Api

The following routes are available for this service:
POST/IapOfferingCreateRequest
IapOfferingCreateRequest Parameters:
NameParameterData TypeRequiredDescription
LookupKeybodystringNo
DisplayNamebodystringNo
IapOfferingResponse Parameters:
NameParameterData TypeRequiredDescription
OfferingformRcOfferingNo
StatusformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
RcOffering Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
IdformstringNo
LookupKeyformstringNo
DisplayNameformstringNo
IsCurrentformboolNo
CreatedAtformlong?No
ProjectIdformstringNo
MetadataformDictionary<string, Object>No
PackagesformRcList<RcPackage>No
ExtraformIDictionary<string, Object>No
RcList<T> Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
ItemsformList<T>No
NextPageformstringNo
UrlformstringNo
RcPackage Parameters:
NameParameterData TypeRequiredDescription
ObjectformstringNo
IdformstringNo
LookupKeyformstringNo
DisplayNameformstringNo
Positionformint?No
ExtraformIDictionary<string, Object>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 /IapOfferingCreateRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	LookupKey: String,
	DisplayName: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offering: 
	{
		Object: String,
		Id: String,
		LookupKey: String,
		DisplayName: String,
		IsCurrent: False,
		CreatedAt: 0,
		ProjectId: String,
		Metadata: 
		{
			String: {}
		},
		Packages: 
		{
			Object: String,
			Items: 
			[
				{
					Object: String,
					Id: String,
					LookupKey: String,
					DisplayName: String,
					Position: 0
				}
			],
			NextPage: String,
			Url: String
		}
	},
	Status: String,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}