AbodeONE

<back to all web services

FindTerms

Requires Authentication
Required role:Admin
The following routes are available for this service:
All Verbs/terms
TermsResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformList<TermDTO>No
ResponseStatusformResponseStatusNo
TermDTO Parameters:
NameParameterData TypeRequiredDescription
TermIdformintNo
NameformstringNo
StartDtformDateTimeNo
EndDtformDateTimeNo
IsSummerformboolNo
DftResrveStartDtformDateTimeNo
DftReserveEndDtformDateTimeNo
BillingStartDtformDateTimeNo
BillingEndDtformDateTimeNo
BillingApplyDtformDateTimeNo
TermCodeformstringNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTimeNo
ModifiedByformstringNo

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

{
	
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	[
		{
			termId: 0,
			name: String,
			startDt: 0001-01-01,
			endDt: 0001-01-01,
			isSummer: False,
			dftResrveStartDt: 0001-01-01,
			dftReserveEndDt: 0001-01-01,
			billingStartDt: 0001-01-01,
			billingEndDt: 0001-01-01,
			billingApplyDt: 0001-01-01,
			termCode: String,
			createdDt: 0001-01-01,
			createdBy: String,
			modifiedDt: 0001-01-01,
			modifiedBy: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}