Cdn API - CPG Source

<back to all web services

InBetweenRequest

Cdn.Api

The following routes are available for this service:
GET/InBetweenRequest
InBetweenRequest Parameters:
NameParameterData TypeRequiredDescription
GroupIdquerylongNo
InBetweenResponse Parameters:
NameParameterData TypeRequiredDescription
CDN_PublicationformInBetweenDataDtoNo
ExportXmlformstringNo
DataformstringNo
BaseResponse Parameters:
NameParameterData TypeRequiredDescription
TotalformintNo
OpCodeformintNo
ErrorTextformstringNo
RequestTimeformstringNo
ResponseTimeformstringNo
TotalExecutionTimeformstringNo
CachedResponseformboolNo
InBetweenDataDto Parameters:
NameParameterData TypeRequiredDescription
StaticPagesformList<InBetweeStaticPage>No
ChapterImagesformList<InBetweenImageDto>No
SeriesDataformList<InBetweenSeriesData>No
InBetweeStaticPage Parameters:
NameParameterData TypeRequiredDescription
PageIDformstringNo
TypeformstringNo
ChapterImageformstringNo
ChapterNameformstringNo
ChapterDescriptionformstringNo
ChapterAuthorformstringNo
ChapterFooterImageformstringNo
ChapterFooterImageCaptionformstringNo
ChapterRevisionDateformstringNo
IntroEpsFileformstringNo
EpilogueEpsFileformstringNo
EpsFileformstringNo
MasterSortOrderformintNo
InBetweenImageDto Parameters:
NameParameterData TypeRequiredDescription
ImageUrlformstringNo
ImageCaptionformstringNo
ImageSourceformstringNo
MasterSortOrderformintNo
InBetweenSeriesData Parameters:
NameParameterData TypeRequiredDescription
SeriesIDformlongNo
SeriesImageformstringNo
SeriesImageFootnoteformstringNo
SeriesNameformstringNo
SeriesDescriptionformstringNo
SortOrderformintNo
MasterSortOrderformintNo
SeriesImagesformList<InBetweenImageDto>No
IssueGroupsformList<InBetweenIssueGroupData>No
InBetweenIssueGroupData Parameters:
NameParameterData TypeRequiredDescription
IssueGroupIdformlongNo
IssueGroupNameformstringNo
IssueGroupDescriptionformstringNo
SortOrderformintNo
MasterSortOrderformintNo
IssueGroupImagesformList<InBetweenImageDto>No
InBetweenIssueGroupEntriesformList<InBetweenIssueGroupEntryData>No
InBetweenIssueGroupEntryData Parameters:
NameParameterData TypeRequiredDescription
DenominationLongformstringNo
VarietyformstringNo
NoteColorformstringNo
GeneralDescriptionformstringNo
ObverseDescriptionformstringNo
ReverseDescriptionformstringNo
NoteDimensionformstringNo
WatermarkformstringNo
PrinterformstringNo
NoteSecurityThreadformstringNo
NotePaperTypeformstringNo
PickNumberformstringNo
BnbNumberformstringNo
IssueGroupEntryPostscriptformstringNo
SortOrderformintNo
MasterSortOrderformintNo
PricingDataformList<InBetweenEntryPricingData>No
IssueGroupEntryPreImagesformList<InBetweenImageDto>No
IssueGroupEntryPostImagesformList<InBetweenImageDto>No
InBetweenEntryPricingData Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
BnbNumberformstringNo
PriceVgformstringNo
PriceVfformstringNo
PriceUncformstringNo
SortOrderformintNo
MasterSortOrderformintNo

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.

GET /InBetweenRequest HTTP/1.1 
Host: cdnapidev.greysheet.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CDN_Publication: 
	{
		StaticPages: 
		[
			{
				PageID: String,
				Type: String,
				ChapterImage: String,
				ChapterName: String,
				ChapterDescription: String,
				ChapterAuthor: String,
				ChapterFooterImage: String,
				ChapterFooterImageCaption: String,
				ChapterRevisionDate: String,
				IntroEpsFile: String,
				EpilogueEpsFile: String,
				EpsFile: String,
				MasterSortOrder: 0
			}
		],
		ChapterImages: 
		[
			{
				ImageUrl: String,
				ImageCaption: String,
				ImageSource: String,
				MasterSortOrder: 0
			}
		],
		SeriesData: 
		[
			{
				SeriesID: 0,
				SeriesImage: String,
				SeriesImageFootnote: String,
				SeriesName: String,
				SeriesDescription: String,
				SortOrder: 0,
				MasterSortOrder: 0,
				SeriesImages: 
				[
					{
						ImageUrl: String,
						ImageCaption: String,
						ImageSource: String,
						MasterSortOrder: 0
					}
				],
				IssueGroups: 
				[
					{
						IssueGroupId: 0,
						IssueGroupName: String,
						IssueGroupDescription: String,
						SortOrder: 0,
						MasterSortOrder: 0,
						IssueGroupImages: 
						[
							{
								ImageUrl: String,
								ImageCaption: String,
								ImageSource: String,
								MasterSortOrder: 0
							}
						],
						InBetweenIssueGroupEntries: 
						[
							{
								DenominationLong: String,
								Variety: String,
								NoteColor: String,
								GeneralDescription: String,
								ObverseDescription: String,
								ReverseDescription: String,
								NoteDimension: String,
								Watermark: String,
								Printer: String,
								NoteSecurityThread: String,
								NotePaperType: String,
								PickNumber: String,
								BnbNumber: String,
								IssueGroupEntryPostscript: String,
								SortOrder: 0,
								MasterSortOrder: 0,
								PricingData: 
								[
									{
										Label: String,
										BnbNumber: String,
										PriceVg: String,
										PriceVf: String,
										PriceUnc: String,
										SortOrder: 0,
										MasterSortOrder: 0
									}
								],
								IssueGroupEntryPreImages: 
								[
									{
										ImageUrl: String,
										ImageCaption: String,
										ImageSource: String,
										MasterSortOrder: 0
									}
								],
								IssueGroupEntryPostImages: 
								[
									{
										ImageUrl: String,
										ImageCaption: String,
										ImageSource: String,
										MasterSortOrder: 0
									}
								]
							}
						]
					}
				]
			}
		]
	},
	ExportXml: String,
	Data: String,
	Total: 0,
	OpCode: 0,
	ErrorText: String,
	RequestTime: String,
	ResponseTime: String,
	TotalExecutionTime: String,
	CachedResponse: False
}