Page Comparison

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"
}

...

• ServiceRequestNotFound = 4041001
  4041001 is a generic MTAPI status used in more than one controller. 4041001 is returned when an end-point expects a valid Service Request identifier, however the passed identifier cannot find any Service Request.

• FileAttachmentNotFound = 4041002
  4041002 is a generic MTAPI status used in more than one controller. 4041002 is returned when an end-point expects a valid file attachment identifier, however the passed identifier cannot find any matching file attachment.

• ServiceRequestNotFound = 4041001, // not found errors starts with 404 followed by 4 digit code 1001, leaving an opportunity use sub status codes below 1000

• UserNotFound = 4041003, // not found errors starts with 404 followed by 4 digit code

• ServiceNotFound = 4041004, // not found errors starts with 404 followed by 4 digit code

• ServiceSettingNotFound = 4041005

• ServicePreferenceNotFound = 4041006

• ClientServiceNotFound = 4041007

• OrganizationNoFound = 4041008

• ArtifactNoFound = 4041009

• ServiceRequestIdNotFound = 4041010

• DocumentNotFound = 4041011

• MetadataStructureNotFound = 4041013

• StructureColumnKeyNameNotFound = 4041014

Generic/Reusable Statuses - can be used in any controller (901000-902999)

• Operation you performed came across internal error, if you keep seeing error contact your lead or support
  InternalError = 901000 // instead of disclosing details, this error may be used

• MtapiSettingError = 901001 // instead of disclosing details, this error may be used

• ArgumentError = 901002, // use this status code for argument related errors where the app used to throw "ArgumentException", where error handler logs error however return a bad request to the caller

• Error in MTAPI service setting, contact MTAPI team to get it resolved
  MtapiSettingError = 901001

• Operation you tried to perform came across argument related error - such as missing argument or invalid value
  ArgumentError = 901002

• An operation cannot be performed because it requires users to be enrolled in a service
  EnrollmentInServiceRequired = 901003

• Must be a valid province
  InvalidProvince = 901004

• In a filter, at least one value is invalid. For further details, refer documentation of an operation where this error occur or contact MTAPI team
  InvalidValueInFilter = 901005

• CurrentUserId does not belong to a real application user
  UserIdNotBelongingToApplication = 901005

• Authorization error
  AuthorizationError = 901006

• ApplicationName is not available
  ApplicationNameNotAvailable = 901006

• Request context is not available
  RequestContextNotAvailable = 901007

• User is not enrolled in any service with read user permission
  NoServiceWithReadUserPermission = 901008

App Controller (603000 - 603999)

...

App Controller (603000-603999)

ServiceArtifacts Controller (622000-622999)

ServiceArtifactNotFound = 622000,

ServiceArtifactRetrievalFailed = 622001,

ServiceArtifactCreationFailed = 622002,

ServiceArtifactNotCreated = 622003,

ServiceArtifactUpdateFailed = 622004,

ServiceArtifactNotUpdated = 622005,

ServiceArtifactDeletionFailed = 622006,

ServiceArtifactAlreadyExists = 622007,

Artifacts Controller (604000-604999)

...

• InvalidArtifactType = 604001

Invalid Artifact Type

• UpdatingArtifactFailed = 604002

Updating Artifact Failed

• DeletingArtifactFailed = 604003

Deleting Artifact Failed

• RetrievingArtifactFailed = 604004

Retrieving Artifact Failed

• CreatingArtifactFailed = 604009

Creating Artifact Failed

• VerifyingArtifactFailed = 604005

Verifying Artifact Failed

• RetrievingDeletedArtifactFailed = 604006

Trying to retrieve deleted artifact failed

• GetArtifactsFailed = 604007

Get Artifacts has failed

• GetArtifactByIdFailed = 604008

Get Artifact by artifact Id has failed

Email Notification Controller (605000-605999)

...

File Attachments Controller (607000-607999)

• InvalidServiceRequestId = 607000 Note: app uses ServiceRequestNotFound = 4041001

• Md5HashNotMatching = 607000
  MD5 hash does not match.

• FileNameWithUnsupportedCharacters = 607001
  File name consists unsupported characters.

• VirusScanResultBlocked = 607002
  Virus Scan Result - Blocked.

• InvalidVirusScanUrl = 607004 Note: app uses MtapiSettingError = 901001

• MISSING_WORKFLOW_RULE = 7005 Note: app uses MtapiSettingError = 901001

Invoices Controller (608000-608999)

...

• CannotCreateStructure = 609000

Organization Controller (

...

611000-

...

611999)

• Retrieving organization failed
  RetrievingOrganizationFailed = 611001

• Organization Id is not valid
  InvalidOrganization = 611002

OutageNotices Controller (611000-611999)

•  RetrievingAllPermissionsFailed

• Adding organization failed

AddingOrganizationFailed = 611003

• Updating organization failed
  UpdatingOrganizationFailed = 611004

• Invalid argument
  InvalidArgument = 611005

• Deleting organization failed
  DeletingOrganizationFailed = 611006

Notices Controller (612000-612999)

• 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

Retrieving all permissions failed

...

Get User by permissions failed

...

Portal Capabilities Controller (

...

614000-

...

614999)

• Get portal capabilities failed.
  GetPortalCapabilitiesFailed = 614000

Service Preferences Controller (615000-615999)

...

• RetrievingServiceRequestFailed = 617001
  Retrieving service request has failed.

• RetrievingServiceRequestsByServicesFailed = 617002
  Retrieving service requests by services has failed.

• RetrievingServiceRequestStatusesFailed = 617003
  Retrieving service request statuses has failed.

• RetrievingServiceRequestStatusHistoryFailed = 617004
  Retrieving service request status history has failed.

• RetrievingServiceArtifactsFailed = 617005
  Retrieving service request artifacts has failed.

• AddServiceRequestFailed = 617006
  Add service request has failed.

• ServiceRequestsQueryFailed = 617007
  Service request query has failed.

• UpdateServiceRequestFailed = 617008
  Service Request couldn't be updated.

• ServiceRequestsByServiceFailed = 617009
  Retrieving service requests by service has failed.

• UpdateServiceRequestStatusFailed = 617010
  Service Request status couldn't be updated.

• DeleteServiceRequestFailed = 617011
  Service Request couldn't be deleted.

• InitiateTransferFailed = 617012
  Service Request couldn't be initiated.

• CompleteTransferFailed = 617013
  Service Request couldn't be completed.

• FileAttachmentByServiceRequestFailed = 617014
  Retrieving file attachment by service request has failed.

• NoRequesterId = 617015
  Retrieving file attachment by service request has failed.

• NoRequesterDetails = 617016
  Retrieving file attachment by service request has failed.

• RetrievingUserAssignmentsFailed = 617017
  Retrieving user assignments has failed.

• RetrievingStatusHistoryExFailed = 617018
  Retrieving extended status history has failed.

• RetrievingStatusHistoryExByGuidFailed = 617019
  Retrieving extended status history by guid has failed.

• UpdateDateCannotBeInFuture = 617020
  Update date cannot be in future.

• ServiceRequestStatusLogNotFound = 617021
  Service Request status log not Found.

• UpdateDateShouldBeAfterPreviousDate = 617022
  The update date should be greater than the previous date.

• UpdateDateShouldBeBeforeNewerDate = 617023
  The update date should be less than the newer date.

• UpdateDateShouldBeAfterPreviousDateAndBeforeNewerDate = 617024
  The update date should be greater than the previous date and less than the newer date.

• UpdateStatusHistoryFailed = 617025
  Service Request Status couldn't be updated.

• UserAssignmentExists = 617026
  User Assignment already exist.

• AddUserAssignmentFailed = 617027
  User Assignments couldn't be added.

• RemoveUserAssignmentFailed = 617028
  User Assignments couldn't be removed.

• InvalidServiceStandard = 617029
  ServiceStandardId is not valid for the service.

• InvalidServiceId = 617030
  Changing ServiceId not allowed.

• DeletedStatus= 617031
  Changing ServiceId not allowed.

• UpdateServiceRequestFail = 617032
  Update ServiceRequest failed.

• RetrievingAuditHistoryFailed = 617033
  Retrieving audit history has failed.

• InvalidServiceRequestId = 6170034
  Invalid ServiceRequest Id.

• InvalidServiceRequestRevisedCreatedDate = 617035
  The Specified Revised Created Date is invalid.

• ServiceRequestIdIsZero = 617036
  Service Request Id is zero.

• AddMultipleUserAssignmentsFailed = 617037
  Multiple User Assignments couldn't be added.

• RemoveMultipleUserAssignmentsFailed = 617038
  Multiple User Assignments couldn't be removed.

• FilterByMetadataFailed = 617039
  Filter service request by metadata has failed.

Services Controller (618000-618999)

...

Users Controller (620000-620999)

Note: Not implemented yet.

...

InvalidUserId = 620000

...

• 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