AbodeONE

<back to all web services

FindWorshipOptions

Requires Authentication
Required role:Admin
The following routes are available for this service:
GET/worship_options
FindWorshipOptions Parameters:
NameParameterData TypeRequiredDescription
WorshipCategoryIdqueryint?No
WorshipOptionsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<WorshipOptionDTO>No
ResponseStatusformResponseStatusNo
WorshipOptionDTO Parameters:
NameParameterData TypeRequiredDescription
WorshipOptionIdformintNo
WorshipCategoryIdformint?No
NameformstringNo
DescriptionformstringNo
CreditsformintNo
PresenterBonusformintNo
DefaultTimeformDateTime?No
DailyLimitformintNo
WeeklyLimitformintNo
TermLimitformintNo
AllowLimitOverrideformboolNo
CodeformstringNo

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 //worship_options HTTP/1.1 
Host: api.lsu.abodehms.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			worshipOptionId: 0,
			worshipCategoryId: 0,
			name: String,
			description: String,
			credits: 0,
			presenterBonus: 0,
			defaultTime: 0001-01-01,
			dailyLimit: 0,
			weeklyLimit: 0,
			termLimit: 0,
			allowLimitOverride: False,
			code: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}