User
User provides access to the user resource.
User Properties
| Property | Example | Description |
|---|---|---|
| id | "62F62D..." | The unique id for the notification record |
| fk_sponsor | "000000..." | The foreign key to the sponsor if a sponsor user |
| fk_host | "000000..." | The foreign key to the host if a host user |
| fk_company | "7AE1E6..." | The foreign key to the company if a company user |
| fk_warehouse | "000000..." | The foreign key to the warehouse if a warehouse user |
| name | "Dougie" | The name of the user |
| "jdcryer@ilevelsoftware.co.uk" | The users email address | |
| type | "system" | Can be system, sponsor, host, company, or warehouse |
| detail | {object} | An object containing the notification detail. |
| notification_user | {related entity} | The related user record detail |
User Methods
| GET | /api/user |
|---|
Returns all user records for the current scope with all published fields.
Example
Example of a returned user entity with all fields
{
"response": {
"page": 1,
"pageCount": 1,
"recordsSent": 1,
"recordsFound": 1,
"user": [
{
"id": "C2355B803935B746B34AA48CB91E327D",
"name": "Dougie",
"email": "jdcryer@ilevelsoftware.co.uk",
"type": "system",
"detail": {
"lang": "en",
"companies": [
"7AE1E6E5FAE546499B36C013916DDEEC"
]
},
"fk_sponsor": "00000000000000000000000000000000",
"fk_host": "00000000000000000000000000000000",
"fk_company": "7AE1E6E5FAE546499B36C013916DDEEC",
"fk_warehouse": "00000000000000000000000000000000",
"user_company": {
"id": "7AE1E6E5FAE546499B36C013916DDEEC",
"name": "i.Level Software Limited",
"address": {
"line1": "2nd Floor Broadway House",
"line2": "The Broadway",
"line3": "Line 3",
"town": "Bedford",
"county": "Bedfordshire",
"postcode": "MK42 2TE",
"countryCode": "GB",
"email": "help@ilevelsupport.co.uk",
"telephone": "01234 761757"
},
"fk_sponsor": "9197BDF4B09F8543B4247E525EBD64A6",
"code": "ILEVEL",
"detail": {
"terms": "i.LEVEL's terms and conditions"
}
},
"user_host": {
"id": "1DA1520A236D604187853C1469B22CC9",
"code": "BCTEST",
"name": "Test Big Commerce",
"type": "BIGCOMMERCE",
"detail": {
"shipMethods": [
{
"host": "ROW - (10 - 12 working days)",
"wh": "INTMAIL"
},
{
"host": "European Delivery (7 - 10 working days)",
"wh": "INTEREU"
},
{
"host": "US Delivery* (10 - 12 working days)",
"wh": "INTERUS"
},
{
"host": "Canada Delivery* (10 - 12 working days)",
"wh": "INTERCAD"
},
{
"host": "UK* Premium Next Working Day Delivery",
"wh": "UK24HR"
},
{
"host": "UK* Premium Next Working Day Delivery. Only available on orders placed Mon - Fri before 3pm",
"wh": "UK24HR"
},
{
"host": "UK* Free Delivery on all orders over £50",
"wh": "UK48HR"
},
{
"host": "UK* Standard Delivery (2 - 3 working days)",
"wh": "UK48HR"
},
{
"host": "UK* Standard Delivery (3 - 5 working days)",
"wh": "UK48HR"
},
{
"host": "UK Mail Saturday",
"wh": "UKSAT"
},
{
"host": "Free Shipping",
"wh": "UK48HR"
},
{
"host": "None",
"wh": "GLOBALIZE"
}
]
}
}
}
]
}
}