Aurora API: Identity Group

Resolve

Deferred: No

This endpoint will attempt to resolve the given Context data to a single Identity Group.

If the given Context data cannot be resolved to an Identity Group, an empty result set is returned.

Example Request

 <AuroraRequestEnvelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
     <Header>
         <AuthToken>...</AuthToken>
     </Header>
     <Requests>
         <Request>
            <IdentityGroup>
                <Resolve>
                    <Context>
                        <ContextItem>
                            <Name>context_item_name</Name>
                            <Value>1</Value>
                        </ContextItem>
                    </Context>
                </Resolve>
            </IdentityGroup>
         </Request>
     </Requests>
 </AuroraRequestEnvelope>

Request Fields

Field	Values	API version	Description	Required
Context	Container	1.5+		Yes
Context.ContextItem	Container	1.5+	At least one ContextItem must be provided	Yes
Context.ContextItem.Name	String	1.5+	Name of the context item. Must be between 4 and 100 characters in length. Must be of the format [a-zA-Z0-9-_]	Yes
Context.ContextItem.Value	String	1.5+	Value of the context item. Must be between 1 and 100 characters in length. Must be of the format [a-zA-Z0-9-_]	Yes

Response Fields

Field	Values	API Version	Description
IdentityGroup	Container	1.5+
IdentityGroup.DateCreated	String	1.5+	Date the Identity Group was created
IdentityGroup.Name	String	1.5+	The name of the Identity Group
IdentityGroup.PriceGroup	String	1.5+	The name of the Price Group associated with the Identity Group

Example response when the given context is resolved to an Identity Group

 <AuroraResponseEnvolope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>1</RequestsSucceeded>
             <RequestErrors>0</RequestErrors>
         </Summary>
     </Header>
     <Responses>
         <Response>
             <RequestID>1</RequestID>
             <Ack>OK</Ack>
             <Data>
                 <IdentityGroup>
                     <ID>27</ID>
                     <DateCreated>0000-00-00 00:00:00</DateCreated>
                     <Name>VIP Customers</Name>
                     <PriceGroup>VIP Customers Prices</PriceGroup>
                 </IdentityGroup>
             </Data>
         </Response>
     </Responses>
</AuroraResponseEnvolope>

Example response when the given context cannot be resolved to an Identity Group

 <AuroraResponseEnvolope>
     <Header>
         <Summary>
             <Ack>OK</Ack>
             <RequestsProcessed>1</RequestsProcessed>
             <RequestsSucceeded>1</RequestsSucceeded>
             <RequestErrors>0</RequestErrors>
         </Summary>
     </Header>
     <Responses>
         <Response>
             <RequestID>1</RequestID>
             <Ack>OK</Ack>
             </Data />
         </Response>
     </Responses>
</AuroraResponseEnvolope>

Updated over 2 years ago