Bombshell Agency Platform Service

<back to all web services

NoteRequest

The following routes are available for this service:
POST,PUT,OPTIONS/Note

To override the Content-type in your clients 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/NoteRequest HTTP/1.1 
Host: api.responsible-advisor.com 
Content-Type: text/jsv
Content-Length: length

{
	InputObject: 
	{
		Id: 0,
		NoteTypeId: Agent_Appointment_Counts,
		TableName: String,
		FieldName: String,
		RecordId: 0,
		NoteText: String,
		DateCreated: 0001-01-01,
		CreatedBy: String,
		DateUpdated: 0001-01-01,
		UpdatedBy: String,
		NoteType: 
		{
			NoteTypeId: Agent_Appointment_Counts,
			NotetypeDescription: String,
			TableNameId: 0,
			TableName: String,
			FieldNameId: 0,
			FieldName: String
		}
	},
	Insert: False,
	Delete: False,
	Update: False
}

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String
			}
		]
	},
	OutputObject: 
	{
		Id: 0,
		NoteTypeId: Agent_Appointment_Counts,
		TableName: String,
		FieldName: String,
		RecordId: 0,
		NoteText: String,
		DateCreated: 0001-01-01,
		CreatedBy: String,
		DateUpdated: 0001-01-01,
		UpdatedBy: String,
		NoteType: 
		{
			NoteTypeId: Agent_Appointment_Counts,
			NotetypeDescription: String,
			TableNameId: 0,
			TableName: String,
			FieldNameId: 0,
			FieldName: String
		}
	}
}