Contents x
    /Endpoint/rest/api/v1/Account
    • 22 Oct 2024
    • 10 Minutes to read
    • Print
    • Dark
      Light
    Contents

    /Endpoint/rest/api/v1/Account

    • Updated on 22 Oct 2024
    • 10 Minutes to read
    • Print
    • Dark
      Light
    Article summary

    Patch
    /Endpoint/rest/api/v1/Account

    Use the AccountData object resource to insert or update (Upsert) Account using Id, Username, ExternalId field(s) value.

    You can supply the required field values in the request data, and then use the POST method of the resource.

    The input parameter must be used in the AccountData record structure inside the FieldType parameter in the foreign key fields.

    Foreign key fields are: TenantId, LanguageId, TimezoneId, DateFormatId

    Update a record of Account

    • If the Id field value is not matched, then a 404 error is reported (Errors/Not Found), and the error record is returned.. You cannot change Id field value (primary key).
    • If the Username, ExternalId field value is not empty and Id field value is empty, action try insert record according Username, ExternalId field value (if set, the value is a unique identifier).

    Create a new record of Account

    • If the value in the Username, ExternalId and Id fields are empty then action insert a new record according input parameter entity record structure (AccountData).

    The response body will contain the object of the updated or created record if the call is successful. Method returns an extended Account structure. Here, all foreign key fields are abstract object structures, utilizing AbstractText or AbstractLong data types, offering a detailed view of the data and related entities.

    Security
    OAuth

    oAuth autentication flow

    FlowClient Credentials
    Token URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
    Refresh URLhttps://dev.esystems.fi/oAuth/rest/v2/Token
    Scopes:
    AccessManager:Create, UpdateAllows to edit access groups and all related data. (ABAC) permissions required to perform a function.
    AccessUser:Create, UpdateAllows to review access groups and all related data. (ABAC) permissions required to perform a function.
    Body parameters

    Account information to insert or update.

    The input parameter must be used in the AccountData record structure inside the FieldType parameter in the foreign key fields.

    object

    The record of Account information.

    Id
    string

    The identifier of account.

    Name
    string

    The name of the account.

    FirstName
    string

    Person's first name.

    LastName
    string

    Person's last name.

    Phone
    string

    The phone number of account. The phone number is unique in the system.

    Email
    string

    The e-mail of account. The email is unique in the system.

    LanguageId
    string

    The enum of Language.

    Valid values[ "ar-ae", "bn-IN", "zh-CN", "da-dk", "en-US", "fo-fo", "fi-FI", "fr-FR", "de-DE", "hi-IN", "ja-JP", "ko-KR", "ms-MY", "pt-PT", "ru-RU", "es-ES", "sv-se", "tr-TR", "ur-IN" ]
    TimezoneId
    string

    The enum of Timezone.

    Valid values[ "Afghanistan Standard Time", "Alaskan Standard Time", "Arab Standard Time", "Arabian Standard Time", "Arabic Standard Time", "Argentina Standard Time", "Atlantic Standard Time", "AUS Central Standard Time", "AUS Eastern Standard Time", "Azerbaijan Standard Time", "Azores Standard Time", "Canada Central Standard Time", "Cape Verde Standard Time", "Caucasus Standard Time", "Cen. Australia Standard Time", "Central America Standard Time", "Central Asia Standard Time", "Central Brazilian Standard Time", "Central Europe Standard Time", "Central European Standard Time", "Central Pacific Standard Time", "Central Standard Time", "Central Standard Time (Mexico)", "China Standard Time", "Dateline Standard Time", "E. Africa Standard Time", "E. Australia Standard Time", "E. Europe Standard Time", "E. South America Standard Time", "Eastern Standard Time", "Egypt Standard Time", "Ekaterinburg Standard Time", "Fiji Standard Time", "FLE Standard Time", "Georgian Standard Time", "GMT Standard Time", "Greenland Standard Time", "Greenwich Standard Time", "GTB Standard Time", "Hawaiian Standard Time", "India Standard Time", "Iran Standard Time", "Israel Standard Time", "Jordan Standard Time", "Korea Standard Time", "Mauritius Standard Time", "Mid-Atlantic Standard Time", "Middle East Standard Time", "Montevideo Standard Time", "Morocco Standard Time", "Mountain Standard Time", "Mountain Standard Time (Mexico)", "Myanmar Standard Time", "N. Central Asia Standard Time", "Namibia Standard Time", "Nepal Standard Time", "New Zealand Standard Time", "Newfoundland Standard Time", "North Asia East Standard Time", "North Asia Standard Time", "Pacific SA Standard Time", "Pacific Standard Time", "Pacific Standard Time (Mexico)", "Pakistan Standard Time", "Romance Standard Time", "Russian Standard Time", "SA Eastern Standard Time", "SA Pacific Standard Time", "SA Western Standard Time", "Samoa Standard Time", "SE Asia Standard Time", "Singapore Standard Time", "South Africa Standard Time", "Sri Lanka Standard Time", "Taipei Standard Time", "Tasmania Standard Time", "Tokyo Standard Time", "Tonga Standard Time", "US Eastern Standard Time", "US Mountain Standard Time", "UTC", "Venezuela Standard Time", "Vladivostok Standard Time", "W. Australia Standard Time", "W. Central Africa Standard Time", "W. Europe Standard Time", "West Asia Standard Time", "West Pacific Standard Time", "Yakutsk Standard Time" ]
    DateFormatId
    string

    The enum of DateFormat.

    Valid values[ "DD-MM-YYYY", "DD/MM/YYYY", "DD.MM.YYYY", "MM-DD-YYYY", "MM/DD/YYYY", "YYYY-MM-DD", "YYYY/MM/DD" ]
    Username
    string

    Username used to log in into the system. The username is unique in the system. The value must be unique in the system and you cannot add multiple values.

    ExternalId
    string

    External Authentication identifier. Example Azure AD guid. The value must be unique in the system and you cannot add multiple values.

    NotifyByEmail
    boolean

    Defines if a person should get notifications via e-mail.

    Defaultfalse
    ExampleFalse
    NotifyBySMS
    boolean

    Defines if a contact should get notifications via SMS.

    Defaultfalse
    ExampleFalse
    Is_Active
    boolean

    Defines if the account is active and can be used.

    Defaultfalse
    ExampleFalse
    Responses
    200

    Inserted or updated Account information.

    Expand All
    object

    The record of Account information.

    Id
    string

    The identifier of account

    TenantId
    object (AbstractLong)

    This structure represents an abstract object with a primary key of type Long. It is used to encapsulate detailed information about related entities.

    Id
    integer (int64)

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Default0
    Example1234567891234567
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    Name
    string

    The name of the account

    FirstName
    string

    Person's first name

    LastName
    string

    Person's last name

    Phone
    string

    The phone number of account. The phone number is unique in the system

    PhoneVerified
    boolean

    Indicates whether the phone number has been verified.

    Defaultfalse
    ExampleFalse
    Email
    string

    The e-mail of account. The email is unique in the system

    EmailVerified
    boolean

    Indicates whether the email address has been verified.

    Defaultfalse
    ExampleFalse
    LanguageId
    object (AbstractText)

    This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.

    Id
    string

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    TimezoneId
    object (AbstractText)

    This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.

    Id
    string

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    DateFormatId
    object (AbstractText)

    This structure represents an abstract object with a primary key of type Text. It is used to encapsulate detailed information about related entities.

    Id
    string

    The primary key of the record. It uniquely identifies each record within the dataset. This attribute is required and must be unique across all records.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    ExternalId
    string

    An external identifier for the record, which can be used to link the record to external systems or datasets. This attribute is optional but should be unique if provided.

    Example3ad64ab3-bd04-46c5-b1d7-c0b34be9e5b5
    Name
    string

    The name of the record. This attribute provides a human-readable identifier for the record, making it easier to recognize and differentiate records in lists or other displays. This attribute is optional.

    ExampleBob Normal
    Type
    string

    The type of the record object. This attribute is used to classify the record into specific categories or types, helping to organize and manage different kinds of records. This attribute is optional.

    ExampleUser
    Username
    string

    Username used to log in into the system. The username is unique in the system

    ExternalId
    string

    External Authentication identifier. Example Azure AD guid

    NotifyByEmail
    boolean

    Defines if a person should get notifications via e-mail

    Defaultfalse
    ExampleFalse
    NotifyBySMS
    boolean

    Defines if a contact should get notifications via SMS

    Defaultfalse
    ExampleFalse
    Is_Active
    boolean

    Defines if the account is active and can be used

    Defaultfalse
    ExampleFalse
    ModifiedOn
    string (date-time)

    The date the record was updated

    Default"1900-01-01T12:00:00Z"
    Example1900-01-01T12:00:00Z
    CreatedOn
    string (date-time)

    The date the record was created

    Default"1900-01-01T12:00:00Z"
    Example1900-01-01T12:00:00Z
    400

    Bad Request - The user has provided input that the browser is unable to convert.

    {
  "Errors": [
    "The user has provided input that the browser is unable to convert.",
    "There are multiple rows in the database for the same value",
    "The value does not match the specified entity structure",
    "..."
  ],
  "Type": "/Errors/Bad Input",
  "Title": "Bad Request",
  "StatusCode": 400,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    401

    Unauthorized - The response status code indicates that the client request has not been completed because it lacks valid authentication credentials for the requested resource.

    {
  "Errors": [
    "The session Id or OAuth token used has expired or is invalid."
  ],
  "Type": "/Errors/Unauthorized",
  "Title": "Unauthorized",
  "StatusCode": 401,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    403

    Forbidden - The user does not have access to execute operation

    {
  "Errors": [
    "The user does not have access to execute operation"
  ],
  "Type": "/Errors/Permission",
  "Title": "Bad Request",
  "StatusCode": 403,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    500

    Internal Server Error - An internal server error is an error on the web server you're trying to access.

    {
  "Errors": [
    "An internal server error is an error on the web server you're trying to access."
  ],
  "Type": "/Errors/Internal Server Error",
  "Title": "Internal Server Error",
  "StatusCode": 500,
  "Instance": "/OpenApi/rest/Xzy",
  "RequestKey": "894ea43c-b8a6-4195-9a9c-82c07d9cc33a"
}
    object

    The list of errors. Throw specific exceptions based on the received error.

    Errors
    Array of string

    Human-readable explanation of the errors

    string
    Default""
    Type
    string

    URI identifier that categorizes the error

    Default""
    Title
    string

    Brief, human-readable message about the error

    Default""
    StatusCode
    integer (int32)

    The HTTP response code

    Example400
    Instance
    string

    URI that identifies the specific occurrence of the error

    Default""
    RequestKey
    string

    Provides a request key that identifies the current request.

    Default""
    Was this article helpful?
    What's Next
    Streamline your low-code application development processes to improve quality and productivity.

    Agile.Now


    Company


    Sales and Support

    © 2021 eSystems Nordic Oy - All rights reserved