Requests and obtains the details of all configured roles. Client applications will generally call this service and cache the result for later use in order to lookup role details by their "internal ID". If a role ID is ever encountered that is not recognized in the client cache, then this service can be called again in order to update the lookup table within the client application. The UMF API equivalent of the getRoles method are the SOA_ROLES_REQUEST input document and the SOA_ROLES_RESPONSE output document.
getRoles ( additionalinfo );
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> <soapenv:Body> <getRoles xmlns="http://services/"> <additionalInfo xsi:nil="true" xmlns=""/> </getRoles> </soapenv:Body> </soapenv:Envelope>
<?xml version="1.0" encoding="UTF-8"?> <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soapenv:Body> <getRolesResponse xmlns="http://services/"> <roles xmlns=""> <internalID>1</internalID> <roleCode>TEST_ROLE</roleCode> <roleDescription>Test Role Code</roleDescription> <roleClass>NT</roleClass> <status>ACTIVE</status> </roles> <roles xmlns=""> <internalID>1159</internalID> <roleCode>GOODROLE</roleCode> <roleDescription>Good Role Code</roleDescription> <roleClass>NT</roleClass> <status>ACTIVE</status> </roles> <roles xmlns=""> <internalID>1160</internalID> <roleCode>BADROLE</roleCode> <roleDescription>Bad Role Code</roleDescription> <roleClass>NT</roleClass> <status>ACTIVE</status> </roles> <roles xmlns=""> <internalID>1161</internalID> <roleCode>NEUTROLE</roleCode> <roleDescription>Neutral Role Code</roleDescription> <roleClass>NT</roleClass> <status>ACTIVE</status> </roles> </getRolesResponse> </soapenv:Body> </soapenv:Envelope>