Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Status codes provide extra information when a request is made to the MTAPI. The response code will be provided when a request has been successfully completed.

...

Response Headers
{
"cache-control": "no-cache",
"content-length": "123",
"content-type": "application/json; charset=utf-8",
"date": "Tue, 20 Apr 2021 11:28:03 GMT",
"expires": "-1",
"mtapistatus": "-1",
"pragma": "no-cache",
"server": "Microsoft-IIS/8.5",
"x-aspnet-version": "4.0.30319",
"x-powered-by": "ASP.NET"
}

...

  • At least one service must be provided.
    Minimum1ServiceRequired = 612001

  • Notice with a certain id is not found.
    NoticeNotFound = 612002

  • Unable to get all notices.
    GetNoticesFailed = 612003

  • Adding a new notice failed.
    AddNoticeFailed = 612004

  • Updating a notice failed.
    UpdateNoticeFailed = 612005

  • Delete notice failed.
    DeleteNoticeFailed = 612006

  • Notice object is null.
    NoticeIsNull = 612007

  • Unable to get all notice types.
    GetNoticeTypesFailed = 612008

  • The start date should be before the end date.
    NoticeStartDateShouldBeBeforeEndDate = 612009

  • The display date should be before the end date.
    NoticeDisplayDateShouldBeBeforeEndDate = 612010

  • Only one service has to be selected for WarningNotice or InformationNotice.
    NoticeOneServiceShouldSelectedBeForWarningOrInfo = 612011

  • Header and Body are required for WarningNotice or InformationNotice.
    NoticeHeaderBodyRequired = 612012,

...

  • Notice header for WarningNotice or InformationNotice should be less than the maximum character limit (150 characters).
    NoticeHeaderOverMaxCharacterLimit = 612013

  • Notice body for WarningNotice or InformationNotice should be less than the maximum character limit (500 characters).

    NoticeBodyOverMaxCharacterLimit = 612014

  • Header and Body shouldn't be entered for planned or unplanned outage.
    NoticeHeaderBodyShouldBeNullForOutageNotice = 612015

Permissions Controller (613000-613999)

  • RetrievingAllPermissionsFailed = 613001

...

  • Call to check whether user exists or not has failed
    UserExistsFailed = 620001

  • Call to check whether user exists or not has failed
    UserExistsFailed = 620001

  • Associate internal user to organization failed
    AssociateInternalUserToOrganizationFails = 620003

  • Retrieving users has failed
    RetrievingUsersFailed = 62000

  • Retrieving user using id has failed
    RetrievingUserByIdFailed = 620005

  • Retrieving user using PKI has failed
    RetrievingUserByPkiFailed = 620006

  • Retrieving users using email has failed
    RetrievingUsersByEmailFailed = 620007

  • Retrieving user using passed credentials has failed
    RetrievingUserByAuthInfoFailed = 620008

  • Retrieving request for user has failed
    RetrievingRequestsForUserFailed = 620009

  • Adding or updating user information has failed
    AddingOrUpdatingUserFailed = 620010

  • Deleting user has failed
    DeletingUserFailed = 620011

  • Retrieving organizations information for a user has failed
    RetrievingOrganizationsForUserFailed = 620012

  • Retrieving business systems information for a user has failed
    RetrievingBusinessSystemsForUserFailed = 620013

  • Retrieving services for a user has failed
    RetrievingServicesByUserFailed = 620014

  • Adding permission to service has failed
    AddingPermissionToServiceFailed = 620015

  • Deleting service permission has failed
    DeletingServicePermissionFailed = 620016

  • Retrieving notices for a user has failed
    RetrievingNoticesForUserFailed = 620017

  • Retrieving permissions of a user has failed
    RetrievingPermissionsByUserFailed = 620018

  • Retrieving permissions for a user's service has failed
    RetrievingPermissionsByUserAndServiceFailed = 620019

  • Searching users has failed
    UserSearchFailed = 620019

...

  • Retrieving granted applications by user id has failed.
    RetrievingExpiredNoticesForUserFailed = 620020

  • Adding Or Updating User Failed Because Email Already Taken
    AddingOrUpdatingUserFailedBecauseEmailAlreadyTaken = 620021

  • Retrieving granted applications by user id has failed.
    GetApplicationsFailed = 620022

  • Retrieving granted applications by user id has failed because of an invalid role id.

    GetApplicationsFailedByInvalidRoleId = 620023

Virus Scan Controller (621000-621999)

UserApplicationManagement Controller (623000 - 623999)

Note: This only for MTOA Platform team

  • Get application information with roles failed.
    GetApplicationByAppIdFailed = 623000

  • Get application information with roles and permission failed.
    ApplicationNotFound = 623001

  • Enroll user in application failed.
    EnrollUserInApplicationFailed = 623002

  • Manage account of this application is not enabled.
    ManageAccountNotEnabled = 623003

  • Unable to enroll the user in the application role.
    User has already the application role.
    UserHasApplicationRole = 623004

  • The Role is not currently supported for the application role enrollment.
    ApplicationRoleNotSupported = 623005

  • User cannot have more than one role per application (other than role 1 or 2).
    CannotNotHaveMoreThanOneAppRole = 623006

  • CreatedByUser does not have the role to manage the application user account.
    MustHaveRoleToManageUser = 623007

  • Get users by application id failed
    GetUsersByApplicationIdFailed = 620338