POST Address

Adds a new address for the indicated userId as that type.

Request URL

https://{school}.myschoolapp.com/api/user/addressforuser?t={token}[&userID]

Parameters

userID intA valid system user ID.

Request headers

Content-Type stringMedia type of the body sent to the API.

Request body

A valid XML/JSON address. AddressLine1 is required to successfuly create an address.

type intA valid address type ID.

{
    "AddressLine1":"123 Any Street",
    "City":"Amherst",
    "UserId":2664710,
    "TypeId":1298
}

Response 200

A ResponseMessage containing the address ID of the new address.


{
  "Message": "2351734"
}

Address Properties

AddressID   integer
AddressLine1   string
AddressLine2   string
AddressLine3   string
BoardingOrHome Acceptable values are B or H string
City   string
Country   string
IsMailingAddress   bool
IsPrimary   bool
Province   string
Region   string
StateShort   string
ZipCode   string

AddressType Properties

Type string
TypeID integer
isPrimary bool
UserID integer
AddressID integer
isPrimary bool
Type string
TypeID integer