design

Documentation

Index

• Variables

Variables

var BillSheetItem = Type("billSheetItem", func() {
	Reference(BillSheetPayload)

	Attribute("id")
	Attribute("specialist")
	Attribute("consumer")
	Attribute("units")
	Attribute("serviceDate")
	Attribute("serviceCode")
	Attribute("contractType")
	Attribute("status")
	Attribute("billedAmount")
	Attribute("confirmation")
	Attribute("description")

	Required("id", "specialist", "consumer", "serviceDate", "serviceCode")
})

var BillSheetMedia = MediaType("application/billsheetapi.billsheetentity", func() {
	Description("BillSheet response")
	TypeName("BillSheetMedia")
	ContentType("application/json")
	Reference(BillSheetPayload)

	Attributes(func() {
		Attribute("id")
		Attribute("specialist")
		Attribute("consumer")
		Attribute("units")
		Attribute("serviceDate")
		Attribute("serviceCode")
		Attribute("contractType")
		Attribute("status")
		Attribute("billedAmount")
		Attribute("confirmation")
		Attribute("description")
		Attribute("billsheets", ArrayOf("billSheetItem"))
		Attribute("pager", Pager)

		Required("id", "specialist", "consumer", "serviceDate", "serviceCode")
	})

	View("default", func() {
		Attribute("id")
		Attribute("specialist")
		Attribute("consumer")
		Attribute("units")
		Attribute("serviceDate")
		Attribute("serviceCode")
		Attribute("contractType")
		Attribute("status")
		Attribute("billedAmount")
		Attribute("confirmation")
		Attribute("description")
	})

	View("paging", func() {
		Attribute("billsheets")
		Attribute("pager")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new billsheets.")
		Attribute("id")
	})
})

var BillSheetPayload = Type("BillSheetPayload", func() {
	Description("BillSheet Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("specialist", Integer, "BillSheet specialist", func() {
		Metadata("struct:tag:datastore", "specialist,noindex")
		Metadata("struct:tag:json", "specialist")
	})
	Attribute("realSpecialist", Integer, "Analogous to linux' real user id", func() {
		Metadata("struct:tag:datastore", "realSpecialist,noindex")
		Metadata("struct:tag:json", "realSpecialist")
	})
	Attribute("consumer", Integer, "BillSheet consumer", func() {
		Metadata("struct:tag:datastore", "consumer,noindex")
		Metadata("struct:tag:json", "consumer")
	})
	Attribute("units", String, "Units units", func() {
		Metadata("struct:tag:datastore", "units,noindex")
		Metadata("struct:tag:json", "units")
	})
	Attribute("serviceDate", String, "BillSheet serviceDate", func() {
		Metadata("struct:tag:datastore", "serviceDate,noindex")
		Metadata("struct:tag:json", "serviceDate")
	})
	Attribute("serviceCode", Integer, "BillSheet serviceCode", func() {
		Metadata("struct:tag:datastore", "serviceCode,noindex")
		Metadata("struct:tag:json", "serviceCode")
	})
	Attribute("contractType", String, "BillSheet contractType", func() {
		Metadata("struct:tag:datastore", "contractType,noindex")
		Metadata("struct:tag:json", "contractType")
	})
	Attribute("status", Integer, "BillSheet status", func() {
		Metadata("struct:tag:datastore", "status,noindex")
		Metadata("struct:tag:json", "status")
	})
	Attribute("billedAmount", Number, "BillSheet billedAmount", func() {
		Metadata("struct:tag:datastore", "billedAmount,noindex")
		Metadata("struct:tag:json", "billedAmount")
	})
	Attribute("confirmation", String, "BillSheet confirmation", func() {
		Metadata("struct:tag:datastore", "confirmation,noindex")
		Metadata("struct:tag:json", "confirmation")
	})
	Attribute("description", String, "BillSheet description", func() {
		Metadata("struct:tag:datastore", "description,noindex")
		Metadata("struct:tag:json", "description")
	})

	Required("specialist", "consumer", "serviceDate", "serviceCode")
})

var BillSheetQueryPayload = Type("BillSheetQueryPayload", func() {
	Description("BillSheet Query Description.")

	Attribute("whereClause", String, "where clause", func() {
		Metadata("struct:tag:datastore", "whereClause,noindex")
		Metadata("struct:tag:json", "whereClause")
	})
})

var ConsumerItem = Type("consumerItem", func() {
	Reference(ConsumerPayload)

	Attribute("id")
	Attribute("firstname")
	Attribute("lastname")
	Attribute("active")
	Attribute("county")
	Attribute("serviceCodes", ArrayOf("unitBlockItem"))
	Attribute("fundingSource")
	Attribute("bsu")
	Attribute("recipientID")
	Attribute("dia")
	Attribute("other")

	Required("id", "firstname", "lastname", "active", "county", "serviceCodes", "fundingSource", "bsu", "recipientID", "dia", "other")
})

var ConsumerMedia = MediaType("application/consumerapi.consumerentity", func() {
	Description("Consumer response")
	TypeName("ConsumerMedia")
	ContentType("application/json")
	Reference(ConsumerPayload)

	Attributes(func() {
		Attribute("id")
		Attribute("firstname")
		Attribute("lastname")
		Attribute("active")
		Attribute("county")
		Attribute("serviceCodes", ArrayOf("unitBlockItem"))
		Attribute("fundingSource")
		Attribute("bsu")
		Attribute("recipientID")
		Attribute("dia")
		Attribute("other")
		Attribute("consumers", ArrayOf("consumerItem"))
		Attribute("pager", Pager)

		Required("id", "firstname", "lastname", "active", "county", "serviceCodes", "fundingSource", "bsu", "recipientID", "dia", "other", "consumers", "pager")
	})

	View("default", func() {
		Attribute("id")
		Attribute("firstname")
		Attribute("lastname")
		Attribute("active")
		Attribute("county")
		Attribute("serviceCodes")
		Attribute("fundingSource")
		Attribute("bsu")
		Attribute("recipientID")
		Attribute("dia")
		Attribute("other")
	})

	View("paging", func() {
		Attribute("consumers")
		Attribute("pager")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new consumers.")
		Attribute("id")
	})
})

var ConsumerPayload = Type("ConsumerPayload", func() {
	Description("Consumer Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("firstname", String, "Consumer firstname", func() {
		Metadata("struct:tag:datastore", "firstname,noindex")
		Metadata("struct:tag:json", "firstname")
	})
	Attribute("lastname", String, "Consumer lastname", func() {
		Metadata("struct:tag:datastore", "lastname,noindex")
		Metadata("struct:tag:json", "lastname")
	})
	Attribute("active", Boolean, "Consumer active", func() {
		Metadata("struct:tag:datastore", "active,noindex")
		Metadata("struct:tag:json", "active")
	})
	Attribute("county", Integer, "Consumer county", func() {
		Metadata("struct:tag:datastore", "county,noindex")
		Metadata("struct:tag:json", "county")
	})
	Attribute("serviceCodes", ArrayOf("unitBlockItem"))
	Attribute("fundingSource", Integer, "Consumer fundingSource", func() {
		Metadata("struct:tag:datastore", "fundingSource,noindex")
		Metadata("struct:tag:json", "fundingSource")
	})
	Attribute("bsu", String, "Consumer bsu", func() {
		Metadata("struct:tag:datastore", "bsu,noindex")
		Metadata("struct:tag:json", "bsu")
	})
	Attribute("recipientID", String, "Consumer recipientID", func() {
		Metadata("struct:tag:datastore", "recipientID,noindex")
		Metadata("struct:tag:json", "recipientID")
	})
	Attribute("dia", Integer, "Consumer dia", func() {
		Metadata("struct:tag:datastore", "dia,noindex")
		Metadata("struct:tag:json", "dia")
	})
	Attribute("other", String, "Consumer other", func() {
		Metadata("struct:tag:datastore", "other,noindex")
		Metadata("struct:tag:json", "other")
	})

	Required("firstname", "lastname", "active", "county", "serviceCodes", "fundingSource", "bsu", "recipientID", "dia", "other")
})

var ConsumerQueryPayload = Type("ConsumerQueryPayload", func() {
	Description("Consumer Query Description.")

	Attribute("whereClause", String, "where clause", func() {
		Metadata("struct:tag:datastore", "whereClause,noindex")
		Metadata("struct:tag:json", "whereClause")
	})
})

var CountyItem = Type("countyItem", func() {
	Reference(CountyPayload)

	Attribute("id")
	Attribute("name")

	Required("id", "name")
})

var CountyMedia = MediaType("application/countyapi.countyentity", func() {
	Description("County response")
	TypeName("CountyMedia")
	ContentType("application/json")
	Reference(CountyPayload)

	Attributes(func() {

		Attribute("id")
		Attribute("name")
		Attribute("counties", ArrayOf("countyItem"))
		Attribute("pager", Pager)

		Required("id", "name", "counties", "pager")
	})

	View("default", func() {
		Attribute("id", Integer)
		Attribute("name", String)
	})

	View("paging", func() {
		Attribute("counties")
		Attribute("pager")
	})

	View("tiny", func() {
		Attribute("id")
	})
})

var CountyPayload = Type("CountyPayload", func() {
	Description("County Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("name", String, "Name", func() {
		Metadata("struct:tag:datastore", "name,noindex")
		Metadata("struct:tag:json", "name")
	})

	Required("name")
})

var DIAItem = Type("DIAItem", func() {
	Reference(DIAPayload)

	Attribute("id")
	Attribute("name")

	Required("id", "name")
})

var DIAMedia = MediaType("application/diacodeapi.diacodeentity", func() {
	Description("DIA response")
	TypeName("DIAMedia")
	ContentType("application/json")
	Reference(DIAPayload)

	Attributes(func() {
		Attribute("id")
		Attribute("name")
		Attribute("dias", ArrayOf("DIAItem"))
		Attribute("pager", Pager)

		Required("id", "name", "dias", "pager")
	})

	View("default", func() {
		Attribute("id")
		Attribute("name")
	})

	View("paging", func() {
		Attribute("dias")
		Attribute("pager")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new dia code.")
		Attribute("id")
	})
})

var DIAPayload = Type("DIAPayload", func() {
	Description("DIA Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("name", String, "DIA name", func() {
		Metadata("struct:tag:datastore", "name,noindex")
		Metadata("struct:tag:json", "name")
	})

	Required("name")
})

var FundingSourceItem = Type("FundingSourceItem", func() {
	Reference(FundingSourcePayload)

	Attribute("id")
	Attribute("name")

	Required("id", "name")
})

var FundingSourceMedia = MediaType("application/fundingsource.fundingsource", func() {
	Description("FundingSource response")
	TypeName("FundingSourceMedia")
	ContentType("application/json")
	Reference(FundingSourcePayload)

	Attributes(func() {
		Attribute("id")
		Attribute("name")
		Attribute("fundingsources", ArrayOf("FundingSourceItem"))
		Attribute("pager", Pager)

		Required("id", "name", "fundingsources", "pager")
	})

	View("default", func() {
		Attribute("id")
		Attribute("name")
	})

	View("paging", func() {
		Attribute("fundingsources")
		Attribute("pager")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new dia code.")
		Attribute("id")
	})
})

var FundingSourcePayload = Type("FundingSourcePayload", func() {
	Description("FundingSource Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("name", String, "FundingSource name", func() {
		Metadata("struct:tag:datastore", "name,noindex")
		Metadata("struct:tag:json", "name")
	})

	Required("name")
})

var Pager = Type("pager", func() {
	Attribute("currentPage", Integer)
	Attribute("recordsPerPage", Integer)
	Attribute("totalCount", Integer)
	Attribute("totalPages", Integer)

	Required("currentPage", "recordsPerPage", "totalCount", "totalPages")
})

var PayHistoryMedia = MediaType("application/payhistoryapi.payhistoryentity", func() {
	Description("PayHistory response")
	TypeName("PayHistoryMedia")
	ContentType("application/json")
	Reference(PayHistoryPayload)

	Attributes(func() {
		Attribute("id")
		Attribute("specialist")
		Attribute("changeDate")
		Attribute("payrate")

		Required("specialist", "changeDate", "payrate")
	})

	View("default", func() {
		Attribute("id")
		Attribute("specialist")
		Attribute("changeDate")
		Attribute("payrate")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new pay history.")
		Attribute("id")
	})
})

var PayHistoryPayload = Type("PayHistoryPayload", func() {
	Description("PayHistory Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("specialist", Integer, "PayHistory specialist", func() {
		Metadata("struct:tag:datastore", "specialist,noindex")
		Metadata("struct:tag:json", "specialist")
	})
	Attribute("changeDate", String, "PayHistory change date", func() {
		Metadata("struct:tag:datastore", "changeDate,noindex")
		Metadata("struct:tag:json", "changeDate")
	})
	Attribute("payrate", Number, "PayHistory payrate", func() {
		Metadata("struct:tag:datastore", "payrate,noindex")
		Metadata("struct:tag:json", "payrate")
	})

	Required("specialist", "changeDate", "payrate")
})

var ServiceCodeMedia = MediaType("application/servicecodeapi.servicecodeentity", func() {
	Description("Service code response")
	TypeName("ServiceCodeMedia")
	ContentType("application/json")
	Reference(ServiceCodePayload)

	Attributes(func() {
		Attribute("id")
		Attribute("name")
		Attribute("unitRate")
		Attribute("description")

		Required("id", "name", "unitRate", "description")
	})

	View("default", func() {
		Attribute("id")
		Attribute("name")
		Attribute("unitRate")
		Attribute("description")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new service code.")
		Attribute("id")
	})
})

var ServiceCodePayload = Type("ServiceCodePayload", func() {
	Description("Service Code Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("name", String, "Service code name", func() {
		Metadata("struct:tag:datastore", "name,noindex")
		Metadata("struct:tag:json", "name")
	})
	Attribute("unitRate", Number, "Service code unit rate", func() {
		Metadata("struct:tag:datastore", "unitRate,noindex")
		Metadata("struct:tag:json", "unitRate")
	})
	Attribute("description", String, "Service code description", func() {
		Metadata("struct:tag:datastore", "description,noindex")
		Metadata("struct:tag:json", "description")
	})

	Required("name", "unitRate", "description")
})

var SessionMedia = MediaType("application/sessionapi.sessionentity", func() {
	Description("Session response")
	TypeName("SessionMedia")
	ContentType("application/json")
	Reference(SessionPayload)

	Attributes(func() {
		Attribute("id")
		Attribute("username")
		Attribute("password")
		Attribute("firstname")
		Attribute("lastname")
		Attribute("active")
		Attribute("email")
		Attribute("payrate", Number)
		Attribute("authLevel", Integer)

		Required("id", "username", "password", "firstname", "lastname", "active", "email", "payrate", "authLevel")
	})

	View("default", func() {
		Attribute("id")
		Attribute("username")
		Attribute("password")
		Attribute("firstname")
		Attribute("lastname")
		Attribute("active")
		Attribute("email")
		Attribute("payrate")
		Attribute("authLevel")
	})

	View("tiny", func() {
		Attribute("id")
		Attribute("password")
	})
})

var SessionPayload = Type("SessionPayload", func() {
	Description("Session Description.")

	Attribute("id", Integer, "Session id", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("username", String, "Session username", func() {
		Metadata("struct:tag:datastore", "username,noindex")
		Metadata("struct:tag:json", "username")
	})
	Attribute("password", String, "Session password", func() {
		Metadata("struct:tag:datastore", "password,noindex")
		Metadata("struct:tag:json", "password")
	})
	Attribute("firstname", String, "Session firstname", func() {
		Metadata("struct:tag:datastore", "firstname,noindex")
		Metadata("struct:tag:json", "firstname")
	})
	Attribute("lastname", String, "Session lastname", func() {
		Metadata("struct:tag:datastore", "lastname,noindex")
		Metadata("struct:tag:json", "lastname")
	})
	Attribute("active", Boolean, "Session active", func() {
		Metadata("struct:tag:datastore", "active,noindex")
		Metadata("struct:tag:json", "active")
	})
	Attribute("email", String, "Session email", func() {
		Metadata("struct:tag:datastore", "email,noindex")
		Metadata("struct:tag:json", "email")
	})
	Attribute("payrate", Number, "Session payrate", func() {
		Metadata("struct:tag:datastore", "payrate,noindex")
		Metadata("struct:tag:json", "payrate")
	})
	Attribute("authLevel", Integer, "Session authLevel", func() {
		Metadata("struct:tag:datastore", "authLevel,noindex")
		Metadata("struct:tag:json", "authLevel")
	})

	Required("password")
})

var SpecialistItem = Type("specialistItem", func() {
	Reference(SpecialistPayload)

	Attribute("id")
	Attribute("username")
	Attribute("password")
	Attribute("firstname")
	Attribute("lastname")
	Attribute("active")
	Attribute("email")
	Attribute("payrate")
	Attribute("authLevel")
	Attribute("loginTime")
	Attribute("currentTime")

	Required("id", "username", "password", "firstname", "lastname", "active", "email", "payrate", "authLevel", "loginTime", "currentTime")

})

var SpecialistMedia = MediaType("application/specialistapi.specialistentity", func() {
	Description("Specialist response")
	TypeName("SpecialistMedia")
	ContentType("application/json")
	Reference(SpecialistPayload)

	Attributes(func() {
		Attribute("id")
		Attribute("username")
		Attribute("password")
		Attribute("firstname")
		Attribute("lastname")
		Attribute("active")
		Attribute("email")
		Attribute("payrate")
		Attribute("authLevel")
		Attribute("loginTime")
		Attribute("currentTime")
		Attribute("users", ArrayOf("specialistItem"))
		Attribute("pager", Pager)

		Required("id", "username", "password", "firstname", "lastname", "active", "email", "payrate", "authLevel", "loginTime", "currentTime", "users", "pager")
	})

	View("default", func() {
		Attribute("id")
		Attribute("username")
		Attribute("password")
		Attribute("firstname")
		Attribute("lastname")
		Attribute("active")
		Attribute("email")
		Attribute("payrate")
		Attribute("authLevel")
		Attribute("loginTime")
		Attribute("currentTime")
	})

	View("paging", func() {
		Attribute("users")
		Attribute("pager")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new specialists.")
		Attribute("id")
	})
})

var SpecialistPayload = Type("SpecialistPayload", func() {
	Description("Specialist Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("username", String, "Specialist username", func() {
		Metadata("struct:tag:datastore", "username,noindex")
		Metadata("struct:tag:json", "username")
	})
	Attribute("password", String, "Specialist password", func() {
		Metadata("struct:tag:datastore", "password,noindex")
		Metadata("struct:tag:json", "password")
	})
	Attribute("firstname", String, "Specialist firstname", func() {
		Metadata("struct:tag:datastore", "firstname,noindex")
		Metadata("struct:tag:json", "firstname")
	})
	Attribute("lastname", String, "Specialist lastname", func() {
		Metadata("struct:tag:datastore", "lastname,noindex")
		Metadata("struct:tag:json", "lastname")
	})
	Attribute("active", Boolean, "Specialist active", func() {
		Metadata("struct:tag:datastore", "active,noindex")
		Metadata("struct:tag:json", "active")
	})
	Attribute("email", String, "Specialist email", func() {
		Metadata("struct:tag:datastore", "email,noindex")
		Metadata("struct:tag:json", "email")
	})
	Attribute("payrate", Number, "Specialist payrate", func() {
		Metadata("struct:tag:datastore", "payrate,noindex")
		Metadata("struct:tag:json", "payrate")
	})
	Attribute("authLevel", Integer, "Specialist authorization level", func() {
		Metadata("struct:tag:datastore", "authLevel,noindex")
		Metadata("struct:tag:json", "authLevel")
	})
	Attribute("loginTime", Integer, "Specialist loginTime", func() {
		Metadata("struct:tag:datastore", "loginTime,noindex")
		Metadata("struct:tag:json", "loginTime")
	})
	Attribute("currentTime", Integer, "Specialist currentTime of latest read", func() {
		Metadata("struct:tag:datastore", "currentTime,noindex")
		Metadata("struct:tag:json", "currentTime")
	})

	Required("username", "password", "firstname", "lastname", "active", "email", "payrate", "authLevel", "loginTime")
})

var SpecialistQueryPayload = Type("SpecialistQueryPayload", func() {
	Description("Specialist Query Description.")

	Attribute("whereClause", String, "where clause", func() {
		Metadata("struct:tag:datastore", "whereClause,noindex")
		Metadata("struct:tag:json", "whereClause")
	})
})

var StatusMedia = MediaType("application/statusapi.statusentity", func() {
	Description("Status response")
	TypeName("StatusMedia")
	ContentType("application/json")
	Reference(StatusPayload)

	Attributes(func() {
		Attribute("id")
		Attribute("name")

		Required("id", "name")
	})

	View("default", func() {
		Attribute("id")
		Attribute("name")
	})

	View("tiny", func() {
		Description("`tiny` is the view used to create new status.")
		Attribute("id")
	})
})

var StatusPayload = Type("StatusPayload", func() {
	Description("Status Description.")

	Attribute("id", Integer, "ID", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})
	Attribute("name", String, "Status name", func() {
		Metadata("struct:tag:datastore", "name,noindex")
		Metadata("struct:tag:json", "name")
	})

	Required("name")
})

var UnitBlockItem = Type("unitBlockItem", func() {
	Attribute("id", Integer, "Units id", func() {
		Metadata("struct:tag:datastore", "id,noindex")
		Metadata("struct:tag:json", "id")
	})

	Attribute("serviceCode", Integer, "Consumer serviceCode", func() {
		Metadata("struct:tag:datastore", "serviceCode,noindex")
		Metadata("struct:tag:json", "serviceCode")
	})
	Attribute("units", Number, "Units units", func() {
		Metadata("struct:tag:datastore", "units,noindex")
		Metadata("struct:tag:json", "units")
	})

	Required("id", "serviceCode", "units")
})