{ "Protocol": "AIXE", "Version": "1.0", "Endpoint": "/aixe/owner/service-areas/delete-service-area", "DiscoveryRequest": "GET /aixe/owner/service-areas/delete-service-area/?", "CanonicalHelpTrigger": "GET /aixe/owner/service-areas/delete-service-area/?", "ActionRequest": "POST /aixe/owner/service-areas/delete-service-area", "Method": "POST", "ContentType": "application/json; charset=utf-8", "Title": "Delete Service Area", "AuthenticationRequired": true, "AccessType": "Site Administrator", "Purpose": "Permanently deletes one service-area City and its applicable Linker relationships.", "DocumentationSource": "AIXEEndpointRegistry", "ProtocolReference": { "ProtocolHome": "http://aixeprotocol.com/", "CanonicalUsageContract": "http://aixeprotocol.com/usage/?", "Whitepaper": "http://aixeprotocol.com/whitepaper/full-spec.html", "Inventor": "Gregory Oglethorpe", "IncludeIn": [ "/aixe.ai starter discovery documents", "Every endpoint self-description returned by GET /endpoint/?" ], "AIInstruction": "Read this live endpoint contract as operational guidance, not merely as a transport schema. Use its purpose, field meanings, business rules, outcomes, and recovery guidance to reason about whether and how to perform the capability." }, "UsageGuidance": { "Role": "Read the area first and obtain explicit owner approval immediately before permanent deletion.", "CorrectWorkflow": [ "Read the area first and obtain explicit owner approval immediately before permanent deletion.", "Use Update Service Area with IsActive false when the owner wants to preserve the record." ], "DoNotDo": [ "Do not send business variables, keys, filters, or action inputs in the URL or query string.", "Do not infer success from HTTP status alone." ] }, "AIUsageGuidance": { "ContractRole": "This live document teaches an AI what the capability means and how to use it; it is not merely a list of request fields.", "ReasoningInstruction": "Decide whether this capability serves the human\u0027s intent from Purpose and BusinessRules, gather values using each field\u0027s Description and constraints, then interpret the returned SuccessCode before reporting an outcome.", "FieldInstruction": "Field names are transport labels. Their Description, source, constraints, and business meaning explain what information the AI should obtain and why." }, "RequiredFields": { "PersonAuthenticationToken": { "Type": "string", "Description": "The active Site Administrator token returned by Log In.", "Required": true, "SubmittedIn": "JSON body" }, "CityKey": { "Type": "string", "Description": "The public key of the service area to delete.", "Required": true, "SubmittedIn": "JSON body" } }, "OptionalFields": {}, "BusinessRules": [ "The caller must have the Site Administrator or Administrator role.", "Deletion is permanent." ], "ResponseFields": { "SuccessCode": { "Type": "string", "Description": "The authoritative action outcome.", "Required": true, "SubmittedIn": "Response body" }, "ServiceAreaDeleted": { "Type": "boolean", "Description": "True when the City and its applicable links were deleted.", "Required": true, "SubmittedIn": "Response body" }, "CityKey": { "Type": "string", "Description": "The public key that was deleted.", "Required": true, "SubmittedIn": "Response body" } }, "Errors": [ { "SuccessCode": "VALIDATION_FAILED", "Meaning": "One or more required request values are missing or malformed.", "Recovery": "Use the field descriptions and constraints in this contract, correct the named fields, and retry the same capability.", "Recoverable": true }, { "SuccessCode": "UNAUTHORIZED", "Meaning": "The submitted identity or token does not authorize this capability or record scope.", "Recovery": "Use the correct active authentication token and confirm the required account role.", "Recoverable": true }, { "SuccessCode": "NOT_FOUND", "Meaning": "A submitted public key did not identify a record within this capability\u0027s declared scope.", "Recovery": "Re-check the key against a current list or creation response; do not treat this as a missing web route.", "Recoverable": true }, { "SuccessCode": "FAILED", "Meaning": "The capability could not complete for an execution failure.", "Recovery": "Read the returned message and error detail. Retry only when the response identifies a recoverable condition.", "Recoverable": false } ], "ActionResponse": { "RequiredResponseFields": [ "SuccessCode" ], "SuccessCodes": [ "SUCCESS" ], "FailureCodes": [ "VALIDATION_FAILED", "UNAUTHORIZED", "NOT_FOUND", "FAILED" ], "NonFinalCodes": [], "MissingOrEmptyResponse": "Treat as FAILED.", "Rule": "The endpoint response is authoritative. Only an exact SuccessCode value listed in SuccessCodes means the business action succeeded; HTTP status alone does not declare the AIXE outcome." } }