Coruson API

<back to all web services

GetSectionTemplates

Coruson Section Templates

Requires Authentication
The following routes are available for this service:
GET/api/sectionTemplatesQuery for Coruson Section Templates
GetSectionTemplates Parameters:
NameParameterData TypeRequiredDescription
SectionTemplateIdqueryGuidNoFilter by the Id of the Section Template
NamequerystringNoFilter by the name of the Section Template
RequestBase Parameters:
NameParameterData TypeRequiredDescription
VersionformintNo
GetSectionTemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
SectionTemplatesformList<SectionTemplate>No
GetResponseBase Parameters:
NameParameterData TypeRequiredDescription
TotalResultsformintNo
SkipformintNo
TakeformintNo
LinksformList<Link>No
ResponseBase Parameters:
NameParameterData TypeRequiredDescription
StatusDescriptionformstringNo
ResponseStatusformResponseStatusNo
Link Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
RequestUrlformstringNo
MethodformstringNo
SectionTemplate Parameters:
NameParameterData TypeRequiredDescription
SectionTemplateIdformGuidNo
NameformstringNo
FieldsformList<FieldBankField>No
FieldBankField Parameters:
NameParameterData TypeRequiredDescription
FieldIdformGuidNo
FieldNameformstringNo
FieldTypeformFieldTypeNo
CollectionTypeformFieldCollectionTypeNo
CollectionIdformGuid?No
CollectionNameformstringNo
RepeaterSectionsformList<RepeaterSection>No
IsActiveformboolNo
RepeaterSection Parameters:
NameParameterData TypeRequiredDescription
SectionTemplateIdformGuidNo
SectionTemplateNameformstringNo

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 /jsv/reply/GetSectionTemplates HTTP/1.1 
Host: platform.gaelenlighten.com 
Content-Type: text/jsv
Content-Length: length

{
	SectionTemplateId: 00000000-0000-0000-0000-000000000000,
	Version: 0,
	Name: String
}
                    
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	SectionTemplates: 
	[
		{
			Name: String,
			Fields: 
			[
				{
					FieldName: String,
					FieldType: All,
					CollectionType: All,
					CollectionId: 00000000-0000-0000-0000-000000000000,
					CollectionName: String,
					RepeaterSections: 
					[
						{
							SectionTemplateName: String
						}
					],
					IsActive: False
				}
			]
		}
	],
	TotalResults: 0,
	StatusDescription: String,
	Skip: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Take: 0,
	Links: 
	[
		{
			Name: String,
			RequestUrl: String,
			Method: String
		}
	]
}