PUT /user/{query:.+}/rehome/{destination}

This service rehomes a user.

Class
user
Name
user_rehome
Method
PUT
URL
/json/user/{query:.+}/rehome/{destination}
/v3/user/{query:.+}/rehome/{destination}
/openapi/user/{query:.+}/rehome/{destination}
URL Parameters
Parameter Data Type Description
query RestQueryTerm Default is the object id of the user. Qualifiers of ObjectId, ExternalId and UserId can be specified. If the user is the primary user of a subscription, then qualifiers for the subscription such as SubscriptionObjectId, SubscriptionExternalId, PhoneNumber, Imsi, AccessNumber, LoginId and AccessId can also be specified.
destination RestQueryTerm Search term to determine the destination domain for the user. It could be a RouteId (RouteId+4) which would identify a server within the domain
Request Parameters
None
Input
UserRehomeRequest 
<UserRehomeRequest>
    <ExecuteMode>{Integer}</ExecuteMode>
    <ApiEventData>
        <MtxApiEventDataExtension />
    </ApiEventData>
    <RelatedMsgId>{String}</RelatedMsgId>
    <ApiEventSecurityInfo>
        <MtxApiEventSecurityInfo>
            <ClientIpAddress>{String}</ClientIpAddress>
            <ClientUserName>{String}</ClientUserName>
            <ClientSessionId>{String}</ClientSessionId>
        </MtxApiEventSecurityInfo>
    </ApiEventSecurityInfo>
</UserRehomeRequest>
Default Output Filter
user_user_rehome = {
    "exclude": [
        "^.*RehomeDataList$",
        "^.*RehomeContextList$"
    ]
}
Output
RehomeResponse 
<RehomeResponse>
    <RehomeStatusCode>{Long}</RehomeStatusCode>
    <RehomeStatusText>{String}</RehomeStatusText>
    <PrepareRehomeResponse>
        <MtxResponseRehome>
            <RehomeContextList>
                <MtxRehomeContext>
                    <ObjectId>{MtxObjectId}</ObjectId>
                    <ObjectRev>{Long}</ObjectRev>
                    <Flags>{Long}</Flags>
                </MtxRehomeContext>
            </RehomeContextList>
            <RehomeDataList>
                <MtxRehomeData />
            </RehomeDataList>
            <RehomePrepareInfo>
                <MtxRehomePrepareInfo>
                    <SourceSubDomainId>{Integer}</SourceSubDomainId>
                    <LastSourceGlobalTxnCounter>{BigInteger}</LastSourceGlobalTxnCounter>
                    <SourceSysSchemaVersion>{Integer}</SourceSysSchemaVersion>
                </MtxRehomePrepareInfo>
            </RehomePrepareInfo>
            <Result>{Long}</Result>
            <ResultText>{String}</ResultText>
            <RelatedMsgId>{String}</RelatedMsgId>
            <TenantId>{String}</TenantId>
        </MtxResponseRehome>
    </PrepareRehomeResponse>
    <DatabaseRehomeResponse>
        <MtxResponse>
            <Result>{Long}</Result>
            <ResultText>{String}</ResultText>
            <RelatedMsgId>{String}</RelatedMsgId>
            <TenantId>{String}</TenantId>
        </MtxResponse>
    </DatabaseRehomeResponse>
    <CommitResponse>
        <MtxResponse>
            <Result>{Long}</Result>
            <ResultText>{String}</ResultText>
            <RelatedMsgId>{String}</RelatedMsgId>
            <TenantId>{String}</TenantId>
        </MtxResponse>
    </CommitResponse>
    <RollbackResponse>
        <MtxResponse>
            <Result>{Long}</Result>
            <ResultText>{String}</ResultText>
            <RelatedMsgId>{String}</RelatedMsgId>
            <TenantId>{String}</TenantId>
        </MtxResponse>
    </RollbackResponse>
    <Result>{Long}</Result>
    <ResultText>{String}</ResultText>
    <RelatedMsgId>{String}</RelatedMsgId>
    <TenantId>{String}</TenantId>
</RehomeResponse>