GetMonthlyProfiles will list an array of available profiles that can be added to an existing monthly account. The profile GUIDs in the response will be used with SetMonthlyProfiles.
Request #
Example #
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:web="http://kleverlogic.com/webservices/"> <soapenv:Header/> <soapenv:Body> <web:GetMonthlyProfiles> <web:securityToken>YOUR_SECURITY_TOKEN</web:securityToken> <web:locationID>PARIS_LOCATION_ID</web:locationID> </web:GetMonthlyProfiles> </soapenv:Body> </soapenv:Envelope>
Parameters #
Value | Description | Data Type |
YOUR_SECURITY_TOKEN | We provide you with a security token Note that this security token will differ from location to location. Your security token for the Monthly API is not used globally across all locations. We will provide you with a different security token per each location you create monthly accounts for. | string |
LOCATION_ID | We provide you with a location ID. The location ID corresponds with the location you are creating or editing monthly accounts for. Note: This equals to the “Monthly API ID” in the Admin Portal | string |
Response #
Example #
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <GetMonthlyProfilesResponse xmlns="http://kleverlogic.com/webservices/"> <GetMonthlyProfilesResult> <Code>RESULT_CODE</Code> <Message>MESSAGE</Message> <LocationProfiles> <LocationProfile> <UniqueID>PROFILE_ID</UniqueID> <Name>PROFILE_NAME</Name> </LocationProfile> </LocationProfiles> </GetMonthlyProfilesResult> </GetMonthlyProfilesResponse> </soap:Body> </soap:Envelope>
Parameters #
The response should include a GetMonthlyProfilesResult object with the following data:
Field | Description |
Code | If the request succeeded, the value of RESULT_CODE will be Success. If the request failed, a relevant error code will be provided. |
Message | A message with clarifying information about the result is provided in this field |
LocationProfiles | Each LocationProfile object includes its unique identifier and its name |