GET api/Session
Create Session ID for user - "Login"
Also returns SystemGroup, APIGroupPermissions, APIObjectPermissions, APIPropertyPermissions, and APIUserCustomers
Session expires in 15 minutes of inactivity.
Request Information
Request body formats
text/plain
Sample:
No body required. Body is ignored.
Response Information
No documentation available.
Response body formats
application/json, text/json
Sample:
{
"SessionID": "7e4f8f18-9581-484b-b75b-4ecdd5906e96",
"SystemGroup": {
"Security_Group": "",
"Security": null,
"Is_External_Group": false,
"Layout_Path": null,
"UserFieldData": null,
"UserFieldNames": null,
"Notifications": []
},
"APIObjectPermissions": [
{
"GroupName": "sample string 1",
"ObjectName": "sample string 2",
"CreateObject": true,
"DeleteObject": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"GroupName": "sample string 1",
"ObjectName": "sample string 2",
"CreateObject": true,
"DeleteObject": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"GroupName": "sample string 1",
"ObjectName": "sample string 2",
"CreateObject": true,
"DeleteObject": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
}
],
"APIPropertyPermissions": [
{
"GroupName": "sample string 1",
"ObjectName": "sample string 2",
"PropertyName": "sample string 3",
"RetrieveProperty": true,
"UpdateProperty": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"GroupName": "sample string 1",
"ObjectName": "sample string 2",
"PropertyName": "sample string 3",
"RetrieveProperty": true,
"UpdateProperty": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"GroupName": "sample string 1",
"ObjectName": "sample string 2",
"PropertyName": "sample string 3",
"RetrieveProperty": true,
"UpdateProperty": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
}
],
"APIVisualPermissions": [
{
"GroupName": "sample string 1",
"PropertyName": "sample string 2",
"Enabled": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"GroupName": "sample string 1",
"PropertyName": "sample string 2",
"Enabled": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"GroupName": "sample string 1",
"PropertyName": "sample string 2",
"Enabled": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
}
],
"APIUserCustomers": [
{
"UserName": "sample string 1",
"CustomerNum": "sample string 2",
"ShipTo": "sample string 3",
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"UserName": "sample string 1",
"CustomerNum": "sample string 2",
"ShipTo": "sample string 3",
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
{
"UserName": "sample string 1",
"CustomerNum": "sample string 2",
"ShipTo": "sample string 3",
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
}
],
"APIGroupPermission": {
"GroupName": "sample string 1",
"Is_Internal_Admin": true,
"Is_External_Admin": true,
"UserFieldData": [
{},
{},
{}
],
"UserFieldNames": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"Notifications": null
},
"NeedsPasswordReset": true
}