AbodeONE

<back to all web services

ExtGetWorshipOption

Requires Authentication
Required role:SAU-Integration
The following routes are available for this service:
GET/external/worship_options/{Id}
ExtGetWorshipOption Parameters:
NameParameterData TypeRequiredDescription
IdpathintNo
ExtGetWorshipOptionResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExtWorshipOptionDTONo
ResponseStatusformResponseStatusNo
ExtWorshipOptionDTO Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
WorshipCategoryformstringNo
NameformstringNo
CreditsformintNo
DefaultTimeformstringNo
DescriptionformstringNo
PresenterBonusformintNo
WeeklyLimitformintNo
DailyLimitformintNo
TermLimitformintNo
AllowOverrideLimitformboolNo
CodeformstringNo
CreatedByformstringNo
CreatedDtformDateTime?No
ModifiedByformstringNo
ModifiedDtformDateTime?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.

GET //external/worship_options/{Id} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		id: 0,
		worshipCategory: String,
		name: String,
		credits: 0,
		defaultTime: String,
		description: String,
		presenterBonus: 0,
		weeklyLimit: 0,
		dailyLimit: 0,
		termLimit: 0,
		allowOverrideLimit: False,
		code: String,
		createdBy: String,
		createdDt: 0001-01-01,
		modifiedBy: String,
		modifiedDt: 0001-01-01
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}