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

...

  • 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

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

...

  • 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)

...