RDAP Types¶

The RDAP (Registration Data Access Protocol, RFC 7483) family models JSON responses from rdap.apnic.net. The defining trait of this family is a shared RDAPResponse base struct — embedded by every top-level response type — that carries rdapConformance, notices, links and the port43 whois pointer.

All types live in models.go.

Class Diagram¶

classDiagram
    class RDAPResponse {
        <<embedded base>>
        +[]string Conformance
        +[]RDAPNotice Notices
        +[]RDAPLink Links
        +string Port43
    }

    class RDAPNetwork {
        +string ObjectClassName
        +string Handle
        +string StartAddress
        +string EndAddress
        +string IPVersion
        +string Name
        +string Country
        +string Type
        +[]string Status
        +[]CIDR0 CIDR0CIDRs
        +[]RDAPEntity Entities
        +[]RDAPEvent Events
        +[]RDAPRemark Remarks
        +string ParentHandle
    }

    class RDAPAutnum {
        +string ObjectClassName
        +string Handle
        +int64 StartAutnum
        +int64 EndAutnum
        +string Name
        +string Type
        +[]string Status
        +string Country
        +[]RDAPEntity Entities
        +[]RDAPEvent Events
        +[]RDAPRemark Remarks
    }

    class RDAPDomain {
        +string ObjectClassName
        +string Handle
        +string LDHName
        +[]RDAPNameserver Nameservers
        +[]RDAPEntity Entities
        +[]RDAPEvent Events
        +[]RDAPRemark Remarks
    }

    class RDAPEntity {
        +string ObjectClassName
        +string Handle
        +[]string Roles
        +[]RDAPEvent Events
        +[]RDAPLink Links
        +[]interface VcardArray
        +[]RDAPEntity Entities
        +[]RDAPRemark Remarks
        +[]string Status
    }

    class RDAPSearchResult {
        +[]interface Results
        +[]RDAPEntity EntitySearchResults
    }

    class RDAPDomainSearchResult {
        +[]RDAPDomain DomainSearchResults
    }

    class RDAPHelpInfo {
    }

    class RDAPNotice {
        +string Title
        +[]string Description
        +[]RDAPLink Links
    }

    class RDAPLink {
        +string Value
        +string Rel
        +string Href
        +string Type
    }

    class RDAPEvent {
        +string EventAction
        +string EventDate
    }

    class RDAPRemark {
        +string Title
        +[]string Description
    }

    class CIDR0 {
        +string V4Prefix
        +string V6Prefix
        +int Length
    }

    class RDAPNameserver {
        +string LDHName
        +[]string IPs
    }

    class RDAPError {
        +int ErrorCode
        +string Title
        +[]string Description
    }

    RDAPNetwork --|> RDAPResponse
    RDAPAutnum --|> RDAPResponse
    RDAPDomain --|> RDAPResponse
    RDAPSearchResult --|> RDAPResponse
    RDAPDomainSearchResult --|> RDAPResponse
    RDAPHelpInfo --|> RDAPResponse
    RDAPNetwork --> CIDR0
    RDAPNetwork --> RDAPEntity
    RDAPNetwork --> RDAPEvent
    RDAPNetwork --> RDAPRemark
    RDAPDomain --> RDAPNameserver
    RDAPNotice --> RDAPLink
    RDAPEntity --> RDAPLink

RDAPResponse — embedded base¶

Every RDAP response embeds RDAPResponse, so the four fields below appear on every top-level type. They are optional (carried with omitempty) and present only when the server includes them.

RDAPNetwork — IP network object¶

Returned by IP and CIDR lookups (RDAPLookupIP, RDAPLookupCIDR).

RDAPAutnum — Autonomous System Number object¶

Returned by ASN lookups (RDAPLookupASN).

RDAPDomain — domain object (reverse DNS)¶

Returned by domain lookups (RDAPLookupDomain).

RDAPEntity — contact/organization¶

Entities are nested under Entities on network/autnum/domain objects, and also appear as the top-level result of RDAPLookupEntity and RDAPSearchResult. An entity may itself contain Entities, producing a tree.

RDAPSearchResult — entity search result¶

Returned by RDAPSearchEntity. APNIC's RDAP search endpoint is /entities (RFC 7482 entitySearch); matches land in EntitySearchResults. The generic Results []interface{} field is retained for forward compatibility with future search endpoints.

RDAPDomainSearchResult — domain search result¶

Returned by RDAPSearchDomain (/domains?name=, RFC 7482 domainSearch). Matching domains land in DomainSearchResults.

Shared sub-structs¶

Lookup flow¶

flowchart LR
    subgraph Call["SDK call"]
        L1["RDAPLookupIP"]
        L2["RDAPLookupCIDR"]
        L3["RDAPLookupASN"]
        L4["RDAPLookupDomain"]
        L5["RDAPLookupEntity"]
        L6["RDAPSearchEntity"]
        L7["RDAPSearchDomain"]
        L8["RDAPHelp"]
    end

    L1 --> RN["RDAPNetwork"]
    L2 --> RN
    L3 --> RA["RDAPAutnum"]
    L4 --> RD["RDAPDomain"]
    L5 --> RE["RDAPEntity"]
    L6 --> RS["RDAPSearchResult"]
    L7 --> RDS["RDAPDomainSearchResult"]
    L8 --> RH["RDAPHelpInfo"]

    RN --> C0["CIDR0"]
    RN --> RE
    RN --> RVT["RDAPEvent"]
    RD --> RNS["RDAPNameserver"]
    RD --> RE