[PUT] Update Account

Get Started. It's Free
or sign up with your email address
Rocket clouds
[PUT] Update Account by Mind Map: [PUT] Update Account

1. Common API Errors

1.1. 401 Unauthorized Unauthorized - Occurs when the authorization token provided is either expired or invalid

1.1.1. Expired/Invalid

1.1.1.1. "message": "Authorization has been denied for this request."

1.2. 403 Forbidden - when the identity server client does not have access to the business - insufficient claims

1.2.1. Required Claims - not applicable at this moment ex. user read only access but trying to update

1.2.1.1. "errorCode": "required_claims", "message": "Unable to process this request due to insufficient client claims.", "errors": [ { "claim": "The name of the claim required." } ]

1.2.2. Access Denied

1.2.2.1. { "errorCode":"access_denied", "message":"Unable to process this request as you do not have access to the account associated to this request." }

1.3. 404 Not Found Not Found - Occurs when the resource provided is not found

1.3.1. "message":"The resource provided could not be found"

1.4. 429 Too many requests More requests than the allowed request limit

1.4.1. "message": "You have exceeded the maximum limit of request allowed. Please try your request again in a moment."

1.4.2. Configuration, to be confirmed with Dev

1.5. 500 Internal Server Error Internal Server Error - Something went wrong on our end ex. Database locked

1.5.1. "message": "Something went wrong while processing your request. We’re sorry for the trouble. We’ve been notified of the error and will correct it as soon as possible. Please try your request again in a moment."

1.6. 503: Service Unavailable Turn off CustomerServices in Application Pool to Test

1.6.1. "message": "The API is currently unavailable due to a scheduled outage – please try again soon."

2. REST API

2.1. 201 Created

2.1.1. when fixedTerm = False

2.2. 400 Bad Request

2.2.1. AccountExternalID

2.2.1.1. AccountExternalID is empty

2.2.1.1.1. { "field":"accountExternalId", "message":"AccountExternalId is required." }

2.2.1.2. Invalid value provided

2.2.1.2.1. { "field":"accountExternalId", "message":"AccountExternalId is invalid." }

2.2.1.3. AccountExternalID exceed max limit example: 51 characters

2.2.1.3.1. { "field":"accountExternalId", "message":"AccountExternalId must not exceed 50 characters." }

2.2.1.4. accountExternalID exist

2.2.1.4.1. { "field":"accountExternalId", "message":"AccountExternalId provided already exists." }

2.2.2. termType

2.2.2.1. termType is empty

2.2.2.1.1. { "field":"termType", "message":"TermType is required." }

2.2.2.2. termType provided is invalid

2.2.2.2.1. { "field":"termType", "message":"TermType is invalid." }

2.2.2.3. when fixedTerm = True

2.2.2.3.1. { "field":"termType", "message":"TermType must not be updated for a fixed term account." }

2.3. 403 Forbidden

2.3.1. Reject/Block Request (except contractAmount)

2.3.1.1. FinishDate is NULL and CancelReason having PendingCancellation = 1

2.3.2. Reject/Block Request (including contractAmount)

2.3.2.1. FinishDate & CancelReason is not NULL

3. DB Validation

4. ELK CRM