Swiftarr Other Structures swiftarr.QuartermasterCreateData Structure Reference

QuartermasterCreateData

public struct QuartermasterCreateData : Content

extension QuartermasterCreateData: RCFValidatable

Used to batch-create one or more QuartermasterItems.

Required by: POST /api/v3/quartermaster/create

See: QuartermasterController.createHandler(_:)

Show on GitHub

category
Whether the items are on offer (have) or wanted (need). Applies to all items in the batch.
Declaration
Swift

var category: QuartermasterCategory
Show on GitHub
location
Optional free-text location where items can be picked up / exchanged. 3–100 characters when present. Required when hideOwnerName is true.
Declaration
Swift

var location: String?
Show on GitHub
hideOwnerName
When true, the owner’s identity is hidden from other users on the created items. Requires location.
Declaration
Swift

var hideOwnerName: Bool
Show on GitHub
items
One or more items to create. 1–10 items per call. Each item has its own name, optional description, and optional photo.
Declaration
Swift

var items: [QuartermasterItemEntry]
Show on GitHub

Quartermaster


                    
                    
                    runValidations(using:)

Declaration

Swift

func runValidations(using decoder: ValidatingDecoder) throws

Show on GitHub

init(from:)
Decodes a create request. hideOwnerName may be omitted from the JSON, in which case it decodes as FALSE.
Declaration
Swift

public init(from decoder: Decoder) throws
Show on GitHub