Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

DescribeRegistrationSectionDefinitions

Retrieves the specified registration section definitions. You can use DescribeRegistrationSectionDefinitions to view the requirements for creating, filling out, and submitting each registration type.

Request Syntax


{
   "MaxResults": number,
   "NextToken": "string",
   "RegistrationType": "string",
   "SectionPaths": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

MaxResults

The maximum number of results to return per each request.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

Required: No

RegistrationType

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_]+

Required: Yes

SectionPaths

An array of paths for the registration form section.

Type: Array of strings

Array Members: Minimum number of 0 items. Maximum number of 5 items.

Length Constraints: Minimum length of 1. Maximum length of 100.

Pattern: [A-Za-z0-9_]+

Required: No

Response Syntax


{
   "NextToken": "string",
   "RegistrationSectionDefinitions": [ 
      { 
         "DisplayHints": { 
            "DocumentationLink": "string",
            "DocumentationTitle": "string",
            "LongDescription": "string",
            "ShortDescription": "string",
            "Title": "string"
         },
         "SectionPath": "string"
      }
   ],
   "RegistrationType": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The token to be used for the next set of paginated results. You don't need to supply a value for this field in the initial request.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Pattern: .+

RegistrationSectionDefinitions

An array of RegistrationSectionDefinition objects.

Type: Array of RegistrationSectionDefinition objects

RegistrationType

The type of registration form. The list of RegistrationTypes can be found using the DescribeRegistrationTypeDefinitions action.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [A-Za-z0-9_]+

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

The request was denied because you don't have sufficient permissions to access the resource.

HTTP Status Code: 400

InternalServerException

The API encountered an unexpected error and couldn't complete the request. You might be able to successfully issue the request again in the future.

HTTP Status Code: 500

ThrottlingException

An error that occurred because too many requests were sent during a certain amount of time.

HTTP Status Code: 400

ValidationException

A validation exception for a field.

HTTP Status Code: 400