MessagingNumberApplicationDto

The practice's application for its own UK mobile number: the Messaging Service's application when there is
one, else the form's prefill from the practice record (status null).

Properties

Name Type Description
statusenum

Draft Submitted InReview Approved Rejected Completed Cancelled Withdrawn

Draft Submitted InReview Approved Rejected Completed Cancelled Withdrawn

detailsMessagingNumberApplicationDetailsDto
addressHintstring

The practice's address as one block of text, to copy from; null when there is none or the details are an
application's own

The practice's address as one block of text, to copy from; null when there is none or the details are an
application's own

submittedDatestring

When it was submitted to the review; null until then

When it was submitted to the review; null until then

reviewedDatestring

When the review approved or rejected it; null until then

When the review approved or rejected it; null until then

rejectionReasonsarray of string

Why it was turned down, in the reviewer's words; empty unless rejected

Why it was turned down, in the reviewer's words; empty unless rejected

fieldErrorsobject

The reviewer's objections by field (representative.email); empty unless known

The reviewer's objections by field (representative.email); empty unless known

phoneNumberstring

The number bought, E.164; null until then

The number bought, E.164; null until then

appliedByUserNamestring

Who applied; null when nobody has

Who applied; null when nobody has

appliedDatestring

When they applied; null when nobody has

When they applied; null when nobody has

reusableMessagingReusableNumberApplicationDto

JSON Example

{
  "status": "Draft",
  "details": {
    "businessName": "string",
    "registrationAuthority": "...",
    "registrationNumber": "string",
    "website": "https://example.com",
    "address": "...",
    "representative": "..."
  },
  "addressHint": "string",
  "submittedDate": "2024-01-01T00:00:00Z",
  "reviewedDate": "2024-01-01T00:00:00Z"
}

Used By Operations