AbodeONE

<back to all web services

UpdateInspection

Requires Authentication
Required role:Admin
The following routes are available for this service:
PATCH/inspections/{InspectionId}
UpdateInspection Parameters:
NameParameterData TypeRequiredDescription
InspectionIdpathintNo
StudentIdqueryintNo
RoomIdqueryintNo
ResidentIdqueryintNo
ReservationIdqueryintNo
InspectionDtqueryDateTimeNo
RepairsNeededquerystringNo
CommentsquerystringNo
StudentSignatureTextquerystringNo
RaSignatureTextquerystringNo
CreatedDtqueryDateTimeNo
CreatedByquerystringNo
ModifiedDtqueryDateTimeNo
ModifiedByquerystringNo
DetailsqueryList<InspectionDetailDTO>No
InspectionDetailDTO Parameters:
NameParameterData TypeRequiredDescription
InspectionDetailIdformint?No
InspectionIdformintNo
NameformstringNo
OrderformintNo
ItemStateformInspectionStateEnum?No
NotesformstringNo
InspectionStateEnum Enum:
Good
Problem
UpdateInspectionResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformInspectionDTONo
ResponseStatusformResponseStatusNo
InspectionDTO Parameters:
NameParameterData TypeRequiredDescription
InspectionIdformintNo
StudentIdformintNo
RoomIdformintNo
ResidentIdformintNo
ReservationIdformintNo
InspectionDtformDateTimeNo
RepairsNeededformstringNo
CommentsformstringNo
StudentSignatureTextformstringNo
RaSignatureTextformstringNo
CreatedDtformDateTimeNo
CreatedByformstringNo
ModifiedDtformDateTimeNo
ModifiedByformstringNo
DetailsformList<InspectionDetailDTO>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.

PATCH //inspections/{InspectionId} HTTP/1.1 
Host: api.lsu-staging.abodehms.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	inspectionId: 0,
	studentId: 0,
	roomId: 0,
	residentId: 0,
	reservationId: 0,
	inspectionDt: 0001-01-01,
	repairsNeeded: String,
	comments: String,
	studentSignatureText: String,
	raSignatureText: String,
	createdDt: 0001-01-01,
	createdBy: String,
	modifiedDt: 0001-01-01,
	modifiedBy: String,
	details: 
	[
		{
			inspectionDetailId: 0,
			inspectionId: 0,
			name: String,
			order: 0,
			itemState: Good,
			notes: String
		}
	]
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		inspectionId: 0,
		studentId: 0,
		roomId: 0,
		residentId: 0,
		reservationId: 0,
		inspectionDt: 0001-01-01,
		repairsNeeded: String,
		comments: String,
		studentSignatureText: String,
		raSignatureText: String,
		createdDt: 0001-01-01,
		createdBy: String,
		modifiedDt: 0001-01-01,
		modifiedBy: String,
		details: 
		[
			{
				inspectionDetailId: 0,
				inspectionId: 0,
				name: String,
				order: 0,
				itemState: Good,
				notes: String
			}
		]
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}