This documentation provides details of all available ADvance API methods.
\nPlease contact Abacus through your regular support channels should you require any further assistance.
\nThe following header values are required to be supplied in all API method requests:
\n\n| HTTP header name | \nPurpose | \n
|---|---|
| ADAPI_ACCESS_HASH | \nThis contains the access hash uniquely identifying the data domain area into which the request is made. Each ADvance brand entity uses a different ADAPI_ACCESS_HASH value. | \n
| ADAPI_ACCESS_TOKEN | \nThis is authorization token to perform the operation in question. This value is common for a single ADvance client/publisher. | \n
| ADAPI_RESPONSE_FORMAT | \nThis value determines the format of the response data. The default is xml. Possible values are 'xml' or 'json'.\n | \n
Handled error responses for API methods are structured as follows:
\n\n\n<ad>
\n<response version=\"1\">
\n<status>
\n<code>ERROR</code>
\n<messages>
\n<msg type=\"error\" code=\"1\">Invalid username/password.</msg>
\n</messages>
\n</status>
\n
Unhandled errors resulting from a generic unplanned technical error / exception in the method may result in an error code of 0 being returned. Such errors should be considered when integrating with the ADvance API methods.
\n\n\n<ad>
\n<response version=\"1\">
\n<status>
\n<code>ERROR</code>
\n<messages>
\n<msg type=\"error\" code=\"0\"></msg>
\n</messages>
\n</status>
\n
The service is used to get all brands and associated details.
\n","urlObject":{"protocol":"https","path":["Brand","GetAllBrands","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[{"id":"d0d86a60-8121-48eb-9980-c2b3e47d36e3","name":"GetAllBrands","originalRequest":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[]},"url":"https://az-adapi.abacusemedia.com/Brand/GetAllBrands/{{version}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNetMvc-Version","value":"5.2"},{"key":"X-Served-By","value":"ADCLOUDWEB3"},{"key":"X-Server-Name","value":"ADCLOUDWEB3"},{"key":"Date","value":"Tue, 01 Feb 2022 09:41:22 GMT"},{"key":"Content-Length","value":"542"},{"key":"Strict-Transport-Security","value":"max-age=16000000; includeSubDomains; preload;"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"version\": \"1\",\n \"status\": {\n \"code\": \"OK\",\n \"messages\": []\n },\n \"data\": {\n \"list\": [\n {\n \"BrandId\": \"1\",\n \"BrandName\": \"Cloud Help\",\n \"Description\": \"Cloud Help\",\n \"Code\": \"\",\n \"PasswordVisibilityMode\": \"ResetPassword\",\n \"StorePasswordInOpenFormat\": \"False\"\n }\n ]\n }\n }\n}"}],"_postman_id":"f50f7df6-79f7-4c64-99c6-b93790ff6f17"}],"id":"e4b30692-9c0b-4e0f-9b89-3999b74baa86","_postman_id":"e4b30692-9c0b-4e0f-9b89-3999b74baa86","description":""},{"name":"Business Intelligence","item":[{"name":"GetBiFilters","id":"52dddda6-97cb-4ae7-9e39-7b469dad5da4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[]},"url":"https://az-adapi.abacusemedia.com/BusinessIntelligence/GetBiFilters/{{version}}","description":"The service is used to get all existing BI filters and associated details.
\n","urlObject":{"protocol":"https","path":["BusinessIntelligence","GetBiFilters","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[{"id":"cd47730b-1ef5-4b3c-913f-3df17faba19d","name":"GetBiFilters","originalRequest":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[]},"url":"https://az-adapi.abacusemedia.com/BusinessIntelligence/GetBiFilters/{{version}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Cache-Control","value":"private"},{"key":"Content-Type","value":"application/json"},{"key":"Server","value":"Microsoft-IIS/10.0"},{"key":"X-AspNetMvc-Version","value":"5.2"},{"key":"X-Served-By","value":"ADCLOUDWEB2"},{"key":"X-Server-Name","value":"ADCLOUDWEB2"},{"key":"Date","value":"Tue, 01 Feb 2022 14:30:09 GMT"},{"key":"Content-Length","value":"60257"},{"key":"Strict-Transport-Security","value":"max-age=16000000; includeSubDomains; preload;"},{"key":"X-UA-Compatible","value":"IE=edge,chrome=1"}],"cookie":[],"responseTime":null,"body":"{\n \"response\": {\n \"version\": \"1\",\n \"status\": {\n \"code\": \"OK\",\n \"messages\": []\n },\n \"data\": {\n \"list\": [\n {\n \"FilterId\": \"338\",\n \"FilterName\": \"BIL_Live_Subscribers_Count_by_Brand\",\n \"FilterType\": \"Advanced_Search\",\n \"DateUpdated\": \"08/12/2021 14:56:42\",\n \"AccessType\": \"PublicReadOnly\"\n },\n {\n \"FilterId\": \"345\",\n \"FilterName\": \"BIL_Party_Payment_Transactions\",\n \"FilterType\": \"System\",\n \"DateUpdated\": \"03/12/2021 15:22:04\",\n \"AccessType\": \"Private\"\n }\n ]\n }\n }\n}"}],"_postman_id":"52dddda6-97cb-4ae7-9e39-7b469dad5da4"}],"id":"edb79c1d-cb41-4d4e-8a7d-11232fec9fde","_postman_id":"edb79c1d-cb41-4d4e-8a7d-11232fec9fde","description":""},{"name":"Login","item":[{"name":"Login","id":"cf58e9b6-3f87-4f8a-aed9-cecaa3b57124","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"Username","value":"","description":"REQUIRED
\n","type":"text"},{"key":"Password","value":"","description":"REQUIRED
\n","type":"text"},{"key":"concurrencyCookie","value":"","description":"REQUIRED - Value held within a client cookie with 12 month expiry. Used for identifying the same client instance logging in to ADvance.
\n","type":"text"},{"key":"IPAddress","value":"","description":"OPTIONAL (although RECOMMENDED) - This value is used to support ADvance's IP restriction functionality.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Login/Login/{{version}}","description":"This service is used to authenticate end users / subscribers with the system via 'username' and 'password' values. The returned 'UserToken' value can be used in subsequent calls to AD API methods where this is required.
\n","urlObject":{"protocol":"https","path":["Login","Login","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"cf58e9b6-3f87-4f8a-aed9-cecaa3b57124"},{"name":"AutoLogin","id":"93725041-ad61-4451-a448-8140969645ea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"frontendCookie","value":"","description":"REQUIRED - The 'frontendCookie' value previously received from a '/Login/Login/1' response.
\n","type":"text"},{"key":"concurrencyCookie","value":"","description":"REQUIRED - Value held within a client cookie with 12 month expiry. Used for identifying the same client instance logging in to ADvance.
\n","type":"text"},{"key":"ipAddress","value":"","description":"OPTIONAL (although RECOMMENDED) - This value is used to support ADvance's IP restriction functionality.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Login/AutoLogin/{{version}}","description":"This service is used to authenticate frontend users with AD based on the frontend cookie value. This cookie value is returned by the /Login method within the 'FrontendCookieValue' property element.
\nWVC/AD frontend sites set this value in a browser cookie named 'ADFEAuthCookie' at login. The WVC and AD frontends also look for this cookie if the user is not logged in, calling the /AutoLogin method and placing the user in a logged in state where validated. Where non-Abacus frontend sites are on the same main domain as the WVC/AD frontend sites, they may also set the 'ADFEAuthCookie' so that the login state is transferred between the sites.
\nLike the /Login method, this method will issue a UserToken for the AD party to be used in subsequent API requests.
\n","urlObject":{"protocol":"https","path":["Login","AutoLogin","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"93725041-ad61-4451-a448-8140969645ea"},{"name":"PasswordlessLogin","id":"5e8c34e5-ab37-472f-9efd-d716d4dd9012","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"partyId","value":"","description":"REQUIRED
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Login/PasswordlessLogin/{{version}}","description":"This service is used to authenticate end users / subscribers with the API system given AD just party ID value. It will basically issue API UserToken for given party ID and brand in question. It can be used for any brand regardless it using surname/URN or user name/password combinations for login.
\nThis service is used to authenticate frontend users with AD based on the Ad party's 'PartyId' value.
\nLike the /Login method, this method will issue a UserToken for the AD party to be used in subsequent API requests.
\n","urlObject":{"protocol":"https","path":["Login","PasswordlessLogin","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5e8c34e5-ab37-472f-9efd-d716d4dd9012"}],"id":"d0de2825-19d8-4700-81ca-f33eb5996b7a","_postman_id":"d0de2825-19d8-4700-81ca-f33eb5996b7a","description":""},{"name":"Newsletter","item":[{"name":"GetNewslettersForBrand","id":"dc212e58-a364-4e0f-bbfe-6e858e3f06e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"UseSharedBrands","value":"","description":"OPTIONAL - true / false.
\nIf true newsletters for any brands in the same group as the API header token/hash will also be returned. Default false.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Newsletter/GetNewslettersForBrand/{{version}}","description":"This API retrieves all active newsletters defined for the brand.
\n","urlObject":{"protocol":"https","path":["Newsletter","GetNewslettersForBrand","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"dc212e58-a364-4e0f-bbfe-6e858e3f06e2"},{"name":"GetSubscribersByNewsletterCode","id":"0e73d91a-0e92-4023-b894-84a3438cc064","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"newsletterCode","value":"","description":"REQUIRED
\n","type":"text"},{"key":"UseSharedBrands","value":"","description":"OPTIONAL - true / false.\nIf true newsletters for any brands in the same group as the API header token/hash will also be returned. Default false.
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/Newsletter/GetSubscribersByNewsletterCode/{{version}}","description":"This API retrieves all subscribers to the given newsletter code.
\n","urlObject":{"protocol":"https","path":["Newsletter","GetSubscribersByNewsletterCode","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0e73d91a-0e92-4023-b894-84a3438cc064"}],"id":"fa01fbb7-13bd-4c9e-ace6-16057003585b","_postman_id":"fa01fbb7-13bd-4c9e-ace6-16057003585b","description":""},{"name":"Order","item":[{"name":"CreateCorporateOrder","id":"f4917c4a-d287-471b-a732-f777baa1765f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"PartyID","value":"","description":"REQUIRED - ID of invoicing party
\n","type":"text"},{"key":"VariantCode","value":"","description":"REQUIRED - source code of variant for which order gets created
\n","type":"text"},{"key":"Quantity","value":"","description":"REQUIRED - number of customers that can be attached to order
\n","type":"text"},{"key":"Price","value":"","description":"REQUIRED - value of order – newly created order will have this amount set as NET value (Tax will be 0)
\n","type":"text"},{"key":"PaymentType","value":"","description":"OPTIONAL - type of payment to be used to mark order as paid.
\nAll payments will be marked as publisher payments as AD will not process any payments for those payment types. Possible values:
\n'Cheque',\n'Credit/debit card',\n'Bank transfer' (DEFAULT),\n'Cash',\n'Other',\n'Publisher VISA',\n'Publisher MasterCard',\n'Publisher MasterCard Debit Card',\n'Publisher VISA Delta',\n'Publisher Maestro',\n'Publisher Amex',\n'Publisher Solo with AVS/CV2',\n'Publisher Diners Club',\n'Publisher Switch Card',\n'Sagepay',\n'Paypal',
\n","type":"text","disabled":true},{"key":"Address1","value":"","description":"REQUIRED
\n","type":"text"},{"key":"Address2","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Address3","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Town","value":"","description":"REQUIRED
\n","type":"text"},{"key":"Postcode","value":"","description":"REQUIRED
\n","type":"text"},{"key":"CountryName","value":"","description":"REQUIRED
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Order/CreateCorporateOrder/{{version}}","description":"Creates corporate order for specified party, variant code, price and amount of available copies.
\n","urlObject":{"protocol":"https","path":["Order","CreateCorporateOrder","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f4917c4a-d287-471b-a732-f777baa1765f"},{"name":"UpsertBeneficiaries (!!! ALPHA !!!)","id":"379f3b0c-2601-4534-a77e-8d7cf5034873","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"requestXML","value":"REQUIRED - internal element values as follows:\n > - REQUIRED (or AdditionalCode) – selects order item for beneficiary amendment\n > – REQUIRED (or OrderId) – selects order item for beneficiary amendment \n > - OPTIONAL – selects specific products by sourcecode for which beneficiaries are to be amended\n > > - REQUIRED\n > > - OPTIONAL – additional validation criteria on user selection. must still match party being selected as beneficiary.\n > > - OPTIONAL – selects existing party by additional code(s). Where multiple > items can be added all will be required on a party in order for it to be selected. must still match party being selected as beneficiary.\n > > - OPTIONAL – Where a new party is created as a beneficiary, this is used as the Firstname\n > > - OPTIONAL - Where a new party is created as a beneficiary, this is used as the Surname
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Order/UpsertBeneficiaries/{{version}}","description":"Generates a set of email invitations to a corporate, online order based on a set of supplied user specifications.
\nINTENDED USAGE MUST BE DISCUSSED WITH ABACUS PRIOR TO THE USAGE OF THIS METHOD.
\n","urlObject":{"protocol":"https","path":["Order","UpsertBeneficiaries","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"379f3b0c-2601-4534-a77e-8d7cf5034873"},{"name":"RemoveBeneficiaries (!!! ALPHA !!!)","id":"feadd200-027c-454f-8494-f8ba0c09f535","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"requestXML","value":"REQUIRED - internal element values as follows:\n > - REQUIRED (or AdditionalCode) – selects order item for beneficiary amendment\n > – REQUIRED (or OrderId) – selects order item for beneficiary amendment \n > - OPTIONAL – selects specific products by sourcecode for which beneficiaries are to be amended\n > > - REQUIRED\n > > - OPTIONAL – additional validation criteria on user selection. must still match party being selected as beneficiary.\n > > - OPTIONAL – selects existing party by additional code(s). Where multiple > items can be added all will be required on a party in order for it to be selected. must still match party being selected as beneficiary.\n > > - OPTIONAL – Where a new party is created as a beneficiary, this is used as the Firstname\n > > - OPTIONAL - Where a new party is created as a beneficiary, this is used as the Surname
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Order/RemoveBeneficiaries/{{version}}","description":"Removes beneficiaries from a corporate, online order based on a set of supplied user specifications.
\nINTENDED USAGE MUST BE DISCUSSED WITH ABACUS PRIOR TO THE USAGE OF THIS METHOD.
\n","urlObject":{"protocol":"https","path":["Order","RemoveBeneficiaries","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"feadd200-027c-454f-8494-f8ba0c09f535"},{"name":"GetBeneficiaries (!!! ALPHA !!!)","id":"12305e9e-4c0d-4f3b-985f-29e64173b6a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"Content-Type","value":"application/x-www-form-urlencoded"},{"key":"ADAPI_RESPONSE_FORMAT","value":"json","type":"text"}],"body":{"mode":"urlencoded","urlencoded":[{"key":"OrderId","value":"","description":"REQUIRED (or AdditionalCode) - OrderId for which to retrieve beneficaries
\n","type":"text"},{"key":"AdditionalCodeType","value":"","description":"REQUIRED (or OrderId) - AddititionalCode for Order to retrieve beneficaries
\n","type":"text","disabled":true},{"key":"AdditionalCode","value":"","description":"REQUIRED (if supplying AdditionalCodeType) - AddititionalCode for Order to retrieve beneficaries
\n","type":"text","disabled":true},{"key":"ProductCode","value":"","description":"OPTIONAL – Selects specific products by sourcecode for which beneficiaries are to be returned
\n","type":"text","disabled":true},{"key":"ResponseAdditionalCodeTypes","value":"","description":"OPTIONAL - Determines what additional codes are returned for beneficiary parties. Values are:
\norder\nparty
\nIf submitted blank, both additional code types are returned.\nIf omitted from the request, no additional code types are returned.
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/Order/GetBeneficiaries/{{version}}","description":"Retrieves beneficiaries attached to an order. Order identifier must be supplied as an OrderId or additional code.
\nINTENDED USAGE MUST BE DISCUSSED WITH ABACUS PRIOR TO THE USAGE OF THIS METHOD.
\n","urlObject":{"protocol":"https","path":["Order","GetBeneficiaries","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"12305e9e-4c0d-4f3b-985f-29e64173b6a8"}],"id":"878cc220-b2f3-4a4c-bfa8-0856135235ce","_postman_id":"878cc220-b2f3-4a4c-bfa8-0856135235ce","description":""},{"name":"Product","item":[{"name":"GetProductList","id":"9114271c-bbac-4433-9a96-de63825f63d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"id","value":"","description":"OPTIONAL. Filtery by product type id. 1: Print, 2: Online; 6: Sundry, 7: Digital, 8: Event
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/Product/GetProductList/{{version}}","description":"This service method returns the list of all products existing in the system (all Live, Deleted are returned) filtered by product type id (as parameter) and brand id (determined by access hash sent by HTTP header).
\n","urlObject":{"protocol":"https","path":["Product","GetProductList","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9114271c-bbac-4433-9a96-de63825f63d0"},{"name":"GetProductByCode","id":"294eb4d6-f038-4e92-8bfa-608583db550d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"code","value":"","description":"REQUIRED - Unique code for the product
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Product/GetProductByCode/{{version}}","description":"The service is used to get obtain product details using its unique code.
\n","urlObject":{"protocol":"https","path":["Product","GetProductByCode","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"294eb4d6-f038-4e92-8bfa-608583db550d"},{"name":"GetAllProducts","id":"1ea0bbd1-c951-484c-8346-d39c51bb4e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"allBrands","value":"","description":"OPTIONAL - true/false - true returns all products for all brands
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/Product/GetAllProducts/{{version}}","description":"The service is used to get all products for a brand. The 'allBrands' parameter enables the user to get all of the products regardless of brand.
\n","urlObject":{"protocol":"https","path":["Product","GetAllProducts","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1ea0bbd1-c951-484c-8346-d39c51bb4e25"},{"name":"GetActiveOffersList","id":"3bd960c7-0844-43e2-b3c5-f364ecbfb80c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[]},"url":"https://az-adapi.abacusemedia.com/Product/GetActiveOffersList/{{version}}","description":"Get all active offers (with status Live) available in the system filtered by the brand.
\n","urlObject":{"protocol":"https","path":["Product","GetActiveOffersList","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3bd960c7-0844-43e2-b3c5-f364ecbfb80c"},{"name":"GetActiveVariantList","id":"1b1e1d73-3fa6-4889-a0a7-3eeacd0d0aea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"id","value":"","description":"REQUIRED - the offer id to which variant is linked
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Product/GetActiveVariantList/{{version}}","description":"Get all active variants (with status Live) available in the system filtered by offer.
\n","urlObject":{"protocol":"https","path":["Product","GetActiveVariantList","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"1b1e1d73-3fa6-4889-a0a7-3eeacd0d0aea"},{"name":"GetRequiredProductsForContent","id":"3ad71c67-c22c-42e6-9880-01c961f090c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"ContentID","value":"","description":"REQUIRED - ID of content controlled by the products (in Webvision this is the story code). This will filter products based on Category rule and Content item rule
\n","type":"text"},{"key":"NavigationUrl","value":"","description":"OPTIONAL - URL address to filter products based on Site area entitlement
\n","type":"text","disabled":true},{"key":"BrandID","value":"","description":"REQUIRED
\n","type":"text"},{"key":"LastModified","value":"","description":"REQUIRED - Content item's last modified date – Before processing, this value will be used to check if the content item has been updated since access entitlements were last checked. If the item has changed (and so may have its categories) then ADvance will re-check the access logic (rather than returning a cached response).
\nFormat: dd-MM-yyyy HH:mm:ss\ne.g. 20-05-2021 22:30:46
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Product/GetRequiredProductsForContent/{{version}}","description":"Get all products which contains provided Content id.
\nThis will include products which have this content item defined in its entitlement rules, either through category, or directly assigned through new entitlement rule.
\nIn order to return site area entitlements, the additional request parameter 'NavigationUrl' must be used.
\n","urlObject":{"protocol":"https","path":["Product","GetRequiredProductsForContent","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3ad71c67-c22c-42e6-9880-01c961f090c3"},{"name":"GetOffersForProduct","id":"fa8d07be-30f0-4acc-ade9-07999590d3b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"ProductID","value":"","description":"REQUIRED
\n","type":"text"},{"key":"IsActiveOnly","value":"","description":"REQUIRED - true/false - determines if only active products are returned.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Product/GetOffersForProduct/{{version}}","description":"This method lists all offers for a product ID, optionally filtering for 'live' items only.
\n","urlObject":{"protocol":"https","path":["Product","GetOffersForProduct","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa8d07be-30f0-4acc-ade9-07999590d3b6"},{"name":"UpsertProductContentItemRule","id":"339b1347-be2f-4be6-a1b1-4a71e8e61c7a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"ProductID","value":"","description":"REQUIRED
\n","type":"text"},{"key":"ContentId","value":"","description":"REQUIRED - metaitem ID. In Webvision this will be story code. This story item will be added as a specific 'grant' entitlement for the specified . The 'GetListOfAvailableProducts' method can be used to review these story 'grant' rules.
\n","type":"text"},{"key":"Title","value":"","description":"REQUIRED
\n","type":"text"},{"key":"Description","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"ContentItemName","value":"","description":"Possibly required, based on gatekeeper configuration for metadata synchronization - check with Abacus
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Product/UpsertProductContentItemRule/{{version}}","description":"This method will insert a content item rule for a product (note this method does not support other rule types).
\nIf metaitem doesn’t exist in Advance, than API will try to sync this metaitem with external source.
\nThese rules will NOT be displayed in the AD backend UI product details screens. To review any rules added by '/UpsertProductContentItemRule' you must use the '/GetListOfAvailableProducts' API method.
\n","urlObject":{"protocol":"https","path":["Product","UpsertProductContentItemRule","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"339b1347-be2f-4be6-a1b1-4a71e8e61c7a"},{"name":"DeleteProductContentItemRule","id":"db20df5b-840c-40c2-b2e6-7c6deb61d44c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"ProductID","value":"","description":"REQUIRED
\n","type":"text"},{"key":"ContentID","value":"","description":"REQUIRED - The story id for which the 'grant' access rule is to be removed from the specified . The 'GetListOfAvailableProducts' method can be used to review current story 'grant' rules.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/Product/DeleteProductContentItemRule/{{version}}","description":"This method will delete a content item rule for a product added via '/UpsertProductContentItemRule'.
\nThese rules will NOT be displayed in the AD backend UI product details screens. To review any rules added by '/UpsertProductContentItemRule' you must use the '/GetListOfAvailableProducts' API method.
\n","urlObject":{"protocol":"https","path":["Product","DeleteProductContentItemRule","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"db20df5b-840c-40c2-b2e6-7c6deb61d44c"},{"name":"GetProductsVariants","id":"15fcf998-5d56-4476-becd-53890bb25443","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"tag","value":"","description":"OPTIONAL - Returns product variants by 'tag' values. If omitted all variants will be retrieved
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/Product/GetProductsVariants/{{version}}","description":"This method will retrieve a product variant list for a specific tag.
\n","urlObject":{"protocol":"https","path":["Product","GetProductsVariants","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"15fcf998-5d56-4476-becd-53890bb25443"}],"id":"50e4c8eb-0e95-4289-ab07-f80832f0b475","_postman_id":"50e4c8eb-0e95-4289-ab07-f80832f0b475","description":""},{"name":"System","item":[{"name":"Get Web Text","id":"c7ade663-88c5-4977-a837-75dfbcef5b6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"code","value":"","description":"REQUIRED - The code of the 'web text' to be returned.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/System/GetWebText/{{version}}/","description":"This method will retrieve web text defined in the System section of the Backend site.
\n","urlObject":{"protocol":"https","path":["System","GetWebText","{{version}}",""],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c7ade663-88c5-4977-a837-75dfbcef5b6c"}],"id":"3c2a566d-bf81-41a6-92b6-1450456a4e1c","_postman_id":"3c2a566d-bf81-41a6-92b6-1450456a4e1c","description":""},{"name":"User","item":[{"name":"CheckUsername","id":"e52d1e9d-91c2-4f64-aab6-d4dcfaec4000","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"Username","value":"","description":"REQUIRED - The username value that is to be checked for availability
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/CheckUsername/{{version}}","description":"This service checks if given username is available for registration. Brand context is determined from the ADAPI_ACCESS_HASH header.
\n","urlObject":{"protocol":"https","path":["User","CheckUsername","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"e52d1e9d-91c2-4f64-aab6-d4dcfaec4000"},{"name":"ForgottenPassword","id":"2bfa0c3c-7f83-4ffc-9f60-962a2629bb38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"Username","value":"","description":"REQUIRED - The username for which a password reset email is to be sent
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/ForgottenPassword/{{version}}","description":"This service is used to email a forgotten password to registered party with given username. Brand context is determined from the ADAPI_ACCESS_HASH header.
\nThe email address used for sending the password is the newest one registered for the brand in question. If no such email exists, then the latest one without a brand context is used.
\n","urlObject":{"protocol":"https","path":["User","ForgottenPassword","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2bfa0c3c-7f83-4ffc-9f60-962a2629bb38"},{"name":"SimpleUserDetails","id":"fa18d66d-15fc-428d-acb1-ab5e32a711fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyId) - User token obtained via the login methods
\n","type":"text"},{"key":"partyId","value":"","description":"REQUIRED (or userToken)
\n","type":"text","disabled":true},{"key":"DemographicsList","value":"","description":"OPTIONAL - comma separated list of demographics codes
\n","type":"text","disabled":true},{"key":"AdditionalCodeList","value":"","description":"OPTIONAL - comma separated list of user additional codes
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/SimpleUserDetails/{{version}}","description":"The service is used to get user details.
\n","urlObject":{"protocol":"https","path":["User","SimpleUserDetails","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"fa18d66d-15fc-428d-acb1-ab5e32a711fd"},{"name":"Regular UserDetails !!! DEPRECATED !!!","id":"0fc105c6-d4e8-46bf-883e-11016ff5bbea","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/UserDetails/{{version}}","description":"THIS METHOD IS DEPRECIATED - Please use '/SimpleUserDetails'.
\n","urlObject":{"protocol":"https","path":["User","UserDetails","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"0fc105c6-d4e8-46bf-883e-11016ff5bbea"},{"name":"GetPartyByAdditionalCode","id":"49916a42-10d3-4be8-bdee-12ebfdbf74d0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"additionalCode","value":"","description":"REQUIRED - Additional code value that will uniquely identify the party in AD system.
\n","type":"text"},{"key":"additionalCodeType","value":"","description":"OPTIONAL - additional code type value. If not provided default configuration value for publisher will be used
\n","type":"text"},{"key":"noCache","value":"","description":"OPTIONAL - true/false - Ensure value is retrieved from database and not in memory cache. Default value is false
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/GetPartyByAdditionalCode/{{version}}","description":"This service is used to retrieve party details in the same way as Regular user details method does (has the same output). The difference is that this method identifies the party in the system by its associated additional code representing the external system identifier of that party. The type of this additional code is different for each client and is determined by publisher configuration setting “AdditionalCodeTypeForLegacyTranslation”. \nAfter determining the Party ID the service will try to identify the user credentials for the brand associated to the token sent in HTTP header. As this is done using the “Passwordless login” method, this means that the user can have random credentials generated when option CONFIGURATION_TYPE_UID is 1 for the respective brand.
\n","urlObject":{"protocol":"https","path":["User","GetPartyByAdditionalCode","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"49916a42-10d3-4be8-bdee-12ebfdbf74d0"},{"name":"GetUserSubscriptions","id":"9b7bc0e5-5d7a-4006-a3a1-3c8b91fe04ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"},{"key":"ipAddress","value":"","description":"OPTIONAL (although RECOMMENDED) - Retrieves subscriptions where qualified by the supplied IP value
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/GetUserSubscriptions/{{version}}","description":"The service is used to get all user subscriptions for brand.\nAll live subscriptions are returned including complimentary and controlled circulation. \nAlso, expired subscriptions that are within renewal range are returned too (using lapsed period setting that is being set via AD Backend, under Configuration/Subscriber settings).\nThe response includes both OrderStatus and SubscriptionStatus (as order may be live, but subscription may be expired).
\n","urlObject":{"protocol":"https","path":["User","GetUserSubscriptions","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9b7bc0e5-5d7a-4006-a3a1-3c8b91fe04ac"},{"name":"UpdateNewsletterSubscriptions","id":"652d2152-617d-4cdd-908a-645ae85c81c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"},{"key":"activateNewsletterCode_CSV","value":"","description":"REQUIRED - (and/or inactivateNewsletterID_CSV) - Comma separated list of newsletter IDs whose subscriptions should be ACTIVATED for current party
\n","type":"text"},{"key":"inactivateNewsletterCode_CSV","value":"","description":"REQUIRED - (and/or activateNewsletterID_CSV) - Comma separated list of newsletter IDs whose subscriptions should be INACTIVATED for current party
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpdateNewsletterSubscriptions/{{version}}","description":"Retrieves newsletter subscriptions for current party.
\n","urlObject":{"protocol":"https","path":["User","UpdateNewsletterSubscriptions","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"652d2152-617d-4cdd-908a-645ae85c81c1"},{"name":"UpdateNewsletterSubscriptionsByEmailAddress","id":"d5e4f079-bdd1-45ae-ae36-b5fa622ebabb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"emailAddress","value":"","description":"Email address of party to update
\n","type":"text"},{"key":"activateNewsletterCode_CSV","value":"","description":"REQUIRED - (and/or inactivateNewsletterID_CSV) - Comma separated list of newsletter IDs whose subscriptions should be ACTIVATED for current party
\n","type":"text"},{"key":"inactivateNewsletterCode_CSV","value":"","description":"REQUIRED - (and/or activateNewsletterID_CSV) - Comma separated list of newsletter IDs whose subscriptions should be INACTIVATED for current party
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpdateNewsletterSubscriptionsByEmailAddress/{{version}}","description":"This service updates newsletter subscriptions for party(s) sharing the same email address.
\n","urlObject":{"protocol":"https","path":["User","UpdateNewsletterSubscriptionsByEmailAddress","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d5e4f079-bdd1-45ae-ae36-b5fa622ebabb"},{"name":"NewsletterSubscriberDetails","id":"d419f681-28da-4c35-a941-dc5334ad9a4d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"partyId","value":"","description":"REQUIRED
\n","type":"text"},{"key":"UseSharedBrands","value":"","description":"OPTIONAL - true / false.\nIf true newsletters for any brands in the same group as the API header token/hash will also be returned. Default false.
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/Newsletter/NewsletterSubscriberDetails/{{version}}","description":"Retrieves user (party) details that can be used when generating email messages or letters etc.
\n","urlObject":{"protocol":"https","path":["Newsletter","NewsletterSubscriberDetails","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d419f681-28da-4c35-a941-dc5334ad9a4d"},{"name":"GetNewsletterSubscriptions","id":"d4e2ceea-5c76-4195-a57e-8e7c3d6f86ee","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyId) - User token obtained via the login methods
\n","type":"text"},{"key":"partyId","value":"","description":"REQUIRED (or userToken)
\n","type":"text","disabled":true},{"key":"useSharedBrands","value":"","description":"OPTIONAL: If set true than all brands from the same shared group, where initial brand belongs, will be searched for newsletters. Default is false
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/GetNewsletterSubscriptions/{{version}}","description":"Retrieves newsletter subscriptions for current party.
\n","urlObject":{"protocol":"https","path":["User","GetNewsletterSubscriptions","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"d4e2ceea-5c76-4195-a57e-8e7c3d6f86ee"},{"name":"GetNewsletterSubscriptionFormat","id":"9c6a2aef-f8ab-4159-b889-3e16a4281821","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/GetNewsletterSubscriptionFormat/{{version}}","description":"This service retrieves newsletter subscription format for current party.
\n","urlObject":{"protocol":"https","path":["User","GetNewsletterSubscriptionFormat","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9c6a2aef-f8ab-4159-b889-3e16a4281821"},{"name":"UpdateNewsletterSubscriptionFormat","id":"b33abcb9-697f-4844-87bd-047b915b070f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"},{"key":"formatID","value":"","description":"REQUIRED - 1 = Plain text, 2 = HTML
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/UpdateNewsletterSubscriptionFormat/{{version}}","description":"This service updates the newsletter subscription format for current party.
\n","urlObject":{"protocol":"https","path":["User","UpdateNewsletterSubscriptionFormat","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b33abcb9-697f-4844-87bd-047b915b070f"},{"name":"AccessAllowed","id":"2b2d613f-30cb-40f4-9990-7f10c5715efe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or CookieID) - For logged in users - UserToken retrieved from Login methods
\n","type":"text"},{"key":"CookieID","value":"","description":"REQUIRED (or userToken) - For anonymous users - This should be a consistent value for the client (i.e. a unique value stored on the client for a period of 1 year).
\n","type":"text","disabled":true},{"key":"Url","value":"","description":"REQUIRED (or MetaId) - Resource string identifier being accessed (these are defined in ADvance product entitlements as a 'site area rule')
\n","type":"text"},{"key":"MetaId","value":"","description":"REQUIRED (or Url) - ID from the frontend engine (Webvision) of the type specified in the MetaType parameter
\n","type":"text"},{"key":"MetaType","value":"","description":"REQUIRED (if supplying MetaId) - Defines the item type specified in MetaId. Possible values: \"Story\", \"Category\"
\n","type":"text"},{"key":"ModifiedDate","value":"","description":"REQUIRED (where MetaType = Story) - Last modified date for story or category mapping depending on what is being requested (this is required for API to check whether the data it has in cache is outdated or not)
\n","type":"text","disabled":true},{"key":"StoryPublishDate","value":"","description":"REQUIRED (where MetaType = Story) - Content item's pubish date - Used to determine expiry date for category rules
\n","type":"text","disabled":true},{"key":"BrandId","value":"","description":"REQUIRED - Brand id under which the meta item is stored (this should be confirmed with Abacus)
\n","type":"text"},{"key":"SourceId","value":"","description":"REQUIRED - ID number for the source of metadata (this should be confirmed with Abacus)
\n","type":"text"},{"key":"ipAddress","value":"","description":"OPTIONAL (although RECOMMENDED) - This checks for content access based on AD's 'IP address' qualification method. Required where AD IP based qualification is to be supported.
\n","type":"text"},{"key":"ReferrerUrl","value":"","description":"OPTIONAL (although RECOMMENDED) - This is the referrer URL from which the content item was accessed. This checks for content access based on AD's 'referrer' qualification method.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/GateKeeper/AccessAllowed/{{version}}","description":"Used to determine whether access should be allowed or not.
\nIn case it returns AccessDenied there is a possibility that Incremental data capture process would allow access if given form is completed. This is the purpose of DataGatheringUrl property in return model. It is a path and a query string to FE site that would take user through the Incremental data capture flow.
\nTo correctly invoke the flow, caller needs to add \"retUrl\" parameter to that value (so via &retUrl=) which would contain URL escaped link to which the FE should redirect after the survey is completed.
\n","urlObject":{"protocol":"https","path":["GateKeeper","AccessAllowed","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"2b2d613f-30cb-40f4-9990-7f10c5715efe"},{"name":"LogWebActivity","id":"57c10eb2-7557-493f-875c-6a3ab3f182dd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyId) - User token obtained via the login methods
\n","type":"text"},{"key":"partyId","value":"","description":"REQUIRED (or userToken)
\n","type":"text","disabled":true},{"key":"MetaId","value":"","description":"REQUIRED - ID (integer) of the entity related to the activity (which is of the indicated type – see MetaType parameter). This value is stored with the activity for extraction via ADvance BI reporting.
\n","type":"text"},{"key":"MetaType","value":"","description":"REQUIRED - Possible values: \"Story\", \"Category\", \"Attachment\"
\n","type":"text"},{"key":"metaTitle","value":"","description":"REQUIRED - Title/name of meta item being actioned
\n","type":"text"},{"key":"actionName","value":"","description":"REQUIRED - Used when looking up web activity to log against. Possible values are:\nOpened\nPassword reset requested\nAccess Granted\nDownload\nUndelivered\nCheckout completed\nUnsuppressed\nSuppressed\nLogin\nCheckout started\nUnsubscribed\nClicked\nAccess Denied
\n","type":"text"},{"key":"metaDataSourceId","value":"","description":"REQUIRED - for Webvision client this is 2. (value TBC with Abacus)
\n","type":"text"},{"key":"actionDate","value":"","description":"OPTIONAL - date and time when the action occurred in one of the following formats (yyyy-MM-dd HH:mm:ss or dd/MM/yyyy HH:mm:ss or dd.MM.yyyy HH:mm:ss ; time can be skipped so dd/MM/yyyy has time 00:00:00) ; this parameter is optional – default value is current date
\n","type":"text","disabled":true},{"key":"ipAddress","value":"","description":"OPTIONAL - records the submitted IP address against the activity. This can be extracted as part of the activity data.
\n","type":"text","disabled":true},{"key":"itemType","value":"","description":"OPTIONAL - default value is Website (2)\nPossible values:\no Newsletter (1)\no Website (2)\no Recruitment (3)\no Events (4)\no Directory (5)\no AccessControl (6)\no Login (7)\no ADFrontend (8)
\nGroup in AD activity listing - custom types can be added to support integration requirements
\n","type":"text","disabled":true},{"key":"numberOfMetaCategories","value":"","description":"REQUIRED (if supplying categoryMeta elements) - denotes how many 'category' items are to be added (i.e. the count of 'categoryMetaId...' elements being included in the request).
\n","type":"text","disabled":true},{"key":"categoryMetaId_0","value":"","description":"REQUIRED (if supplying a categoryMeta... element) - This MUST be a UNIQUE integer for the 'categoryMetaTitle...' value. Supplying the same 'categoryMetaId...' with a different 'categoryMetaTitle...' will result in the title being changed for all previously added categories.
\n","type":"text","disabled":true},{"key":"categoryMetaTypeId_0","value":"","description":"REQUIRED (if supplying a categoryMeta... element) - Use default 1
\n","type":"text","disabled":true},{"key":"categoryMetaTitle_0","value":"","description":"REQUIRED (if supplying a categoryMeta... element) - The category name (string)
\n","type":"text","disabled":true},{"key":"categoryMetaId_1","value":"","type":"text","disabled":true},{"key":"categoryMetaTypeId_1","value":"","type":"text","disabled":true},{"key":"categoryMetaTitle_1","value":"","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/LogWebActivity/{{version}}","description":"Used to log an activity performed by a user combined with MetaItem and MetaCategory classification.
\n","urlObject":{"protocol":"https","path":["User","LogWebActivity","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"57c10eb2-7557-493f-875c-6a3ab3f182dd"},{"name":"OptOutProduct","id":"5cd24704-d6e4-4168-b935-006192f8cb2b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"emailAddress","value":"","description":"REQUIRED - the email address that needs to be opted out
\n","type":"text"},{"key":"productCode","value":"","description":"REQUIRED - the unique code for the product
\n","type":"text"},{"key":"createParty","value":"","description":"OPTIONAL - default false. If true, and party with given email address is not found, it will be created using the following conventions: First name is first letter of email address, last name is the domain of the email address
\n","type":"text"},{"key":"sourceCode","value":"","description":"OPTIONAL - default empty. If specified, this source code is attached to the party. If the source code does not exist, it will be created
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/OptOutProduct/{{version}}","description":"Opt out from receiving email communications for the product.
\n","urlObject":{"protocol":"https","path":["User","OptOutProduct","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5cd24704-d6e4-4168-b935-006192f8cb2b"},{"name":"UpdatePassword","id":"7108e01b-cdfa-4d03-8a9c-0a412dd29911","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"},{"key":"Password","value":"","description":"REQUIRED - New password to be set
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/UpdatePassword/{{version}}","description":"The service is used to update password on an existing party's credential.
\n","urlObject":{"protocol":"https","path":["User","UpdatePassword","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"7108e01b-cdfa-4d03-8a9c-0a412dd29911"},{"name":"ResetPassword","id":"51c071f4-f62a-4cd3-bb42-8ff2bd58431d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userName","value":"","description":"REQUIRED - The username for the party to be sent a password reset email
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/ResetPassword/{{version}}","description":"Send reset password e-mail to user identified by username on brand determined by access token.
\n","urlObject":{"protocol":"https","path":["User","ResetPassword","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"51c071f4-f62a-4cd3-bb42-8ff2bd58431d"},{"name":"ChangeUserActivationStatus","id":"01f8ae33-9b1a-43e6-90e9-f38dfd502645","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"UserToken","value":"","description":"REQUIRED (or partyId) - User token obtained via the login methods - Identifes party to change registration activation flag on the context brand.
\n","type":"text"},{"key":"id","value":"","description":"REQUIRED (or UserToken) - This is the 'partyId' value
\n","type":"text"},{"key":"active","value":"","description":"REQUIRED - Boolean value determining the new state of registration activation flag (can be true, false, 1 or 0)
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/ChangeUserActivationStatus/{{version}}","description":"Change user registration “is active” flag.
\n","urlObject":{"protocol":"https","path":["User","ChangeUserActivationStatus","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"01f8ae33-9b1a-43e6-90e9-f38dfd502645"},{"name":"SendRegistrationActivationEmail","id":"734e85af-d71a-4dd4-b93b-1fd788978a88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"UserToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/SendRegistrationActivationEmail/{{version}}","description":"Used to send the registration activation e-mail to the user that has just registered to the website. The user registration is identified by the User-Token HTTP header.
\n","urlObject":{"protocol":"https","path":["User","SendRegistrationActivationEmail","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"734e85af-d71a-4dd4-b93b-1fd788978a88"},{"name":"GetSingleSignOnCookieDetails","id":"5bc37a7e-e3d9-4898-b7b6-28ebdb1e19dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/GetSingleSignOnCookieDetails/{{version}}","description":"Retrieve Single Sign On cookie for a user based on their details (registration, name, email etc.).
\n","urlObject":{"protocol":"https","path":["User","GetSingleSignOnCookieDetails","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"5bc37a7e-e3d9-4898-b7b6-28ebdb1e19dc"},{"name":"UpsertParty","id":"36511e54-b3d4-4f6d-b6ea-151d70f3169f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"PartyID","value":"","description":"OPTIONAL - if this value is set, than API will try to update party with new data. If party has not been found for specified ID, or ID has not been specified, new party will be inserted
\n","type":"text"},{"key":"PartyType","value":"","description":"REQUIRED - Possible values: \"Person\", \"Company\"
\n","type":"text"},{"key":"RecordStatus","value":"","description":"OPTIONAL - Possible values: \"Live\", \"Cancelled\", \"Deceased\", \"Inactive\", \"Merged\". Default is \"Live\"
\n","type":"text","disabled":true},{"key":"Title","value":"","description":"REQUIRED (if PartyType = Person) (or TitleId supplied)
\n","type":"text"},{"key":"TitleId","value":"","description":"REQUIRED (if PartyType = Person) (or Title supplied)
\n","type":"text","disabled":true},{"key":"Forename","value":"","description":"REQUIRED (if PartyType = Person)
\n","type":"text"},{"key":"Surname","value":"","description":"REQUIRED (if PartyType = Person)
\n","type":"text"},{"key":"Suffix","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"DateOfBirth","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Deceased","value":"","description":"OPTIONAL - Possible values: \"Living\", \"Deceased\"
\n","type":"text","disabled":true},{"key":"GenderId","value":"","description":"OPTIONAL - Possible values: \"Male\", \"Female\", \"Unknown\"
\n","type":"text","disabled":true},{"key":"NiNumber","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"MiddleInitial","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Salutation","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Fullname","value":"","description":"REQUIRED (if PartyType = Company) - If party is a company this field is mandatory. If a person this is not required and will not be used
\n","type":"text","disabled":true},{"key":"CompanyName","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"RegisteredNumber","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"TradingStatus","value":"","description":"OPTIONAL - Company trading status. Possible values: \"Trading\", \"NotSet\", \"CeasedTrading\", \"Closed\", \"Liquidated\", \"BoughtOut\". Default is \"Trading\"
\n","type":"text","disabled":true},{"key":"AnnualTurnover","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"NumberOfEmployees","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"VatNumber","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"IndustryCode","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"IsBureau","value":"","description":"OPTIONAL - true/false
\n","type":"text","disabled":true},{"key":"SourceCodesCsv","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"DeleteMissingSourceCode","value":"","description":"OPTIONAL - where false sourcecodes are not removed when the party upsert is completed
\n","type":"text","disabled":true},{"key":"CompanyCode","value":"","description":"OPTIONAL
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpsertParty/{{version}}","description":"This method supports the creation or update of AD parties.
\nExisting parties will be matched by the supplied 'PartyID' value.
\n","urlObject":{"protocol":"https","path":["User","UpsertParty","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"36511e54-b3d4-4f6d-b6ea-151d70f3169f"},{"name":"UpsertPartyWithAdditionalCode","id":"08f40c00-8e5b-4b7c-aed8-50cba4aae245","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"AdditionalCodeTypeName","value":"","description":"REQUIRED - additional code to be used for party matching
\n","type":"text"},{"key":"Code","value":"","description":"REQUIRED - additional code value to match
\n","type":"text"},{"key":"SubjectType","value":"","description":"REQUIRED - additional code subject type. Possible values: \"Party\", \"Address\", \"Communication\". For party insert update, use party subject type
\n","type":"text"},{"key":"RecordStatus","value":"","description":"REQUIRED - additional code status. Possible values: \"Live\", \"Deleted\"
\n","type":"text"},{"key":"ForbidAddingDuplicateValue","value":"","description":"OPTIONAL - true/false, default false. If false, duplicated additional codes will be attached to party. If true, additional codes already attached to party will not be added again
\n","type":"text","disabled":true},{"key":"Title","value":"","description":"As per UpsertParty
\n","type":"text"},{"key":"TitleId","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Forename","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Surname","value":"","description":"As per UpsertParty
\n","type":"text"},{"key":"Suffix","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"DateOfBirth","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Deceased","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"GenderId","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"NiNumber","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"MiddleInitial","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Salutation","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Fullname","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"CompanyName","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"RegisteredNumber","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"TradingStatus","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"AnnualTurnover","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"NumberOfEmployees","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"VatNumber","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"IndustryCode","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"IsBureau","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"SourceCodesCsv","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"DeleteMissingSourceCode","value":"","description":"OPTIONAL - where false sourcecodes are not removed when the party upsert is completed
\n","type":"text","disabled":true},{"key":"CompanyCode","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"ForbidUsernameAsCommunication","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpsertPartyWithAdditionalCode/{{version}}","urlObject":{"protocol":"https","path":["User","UpsertPartyWithAdditionalCode","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"08f40c00-8e5b-4b7c-aed8-50cba4aae245"},{"name":"UpsertPartyWithAdditionalCode - New company upsert","id":"f99b1eef-2ec2-42ef-94e3-f94f35055246","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"AdditionalCodeTypeName","value":"CRM_Individual_Id","description":"REQUIRED - additional code to be used for party matching
\n","type":"text"},{"key":"Code","value":"1","description":"REQUIRED - additional code value to match
\n","type":"text"},{"key":"SubjectType","value":"Party","description":"REQUIRED - additional code subject type. Possible values: \"Party\", \"Address\", \"Communication\". For party insert update, use party subject type
\n","type":"text"},{"key":"PartyType","value":"Person","type":"text"},{"key":"RecordStatus","value":"Live","description":"REQUIRED - additional code status. Possible values: \"Live\", \"Deleted\"
\n","type":"text"},{"key":"ForbidAddingDuplicateValue","value":"true","description":"OPTIONAL - true/false, default false. If false, duplicated additional codes will be attached to party. If true, additional codes already attached to party will not be added again
\n","type":"text"},{"key":"Title","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"TitleId","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Forename","value":"Upsert contact with company-2","description":"As per UpsertParty
\n","type":"text"},{"key":"Surname","value":"Test 1-2","description":"As per UpsertParty
\n","type":"text"},{"key":"Suffix","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"DateOfBirth","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Deceased","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"GenderId","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"NiNumber","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"MiddleInitial","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Salutation","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"Fullname","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"CompanyName","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"RegisteredNumber","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"TradingStatus","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"AnnualTurnover","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"NumberOfEmployees","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"VatNumber","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"IndustryCode","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"IsBureau","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"SourceCodesCsv","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"DeleteMissingSourceCode","value":"","description":"OPTIONAL - where false sourcecodes are not removed when the party upsert is completed
\n","type":"text","disabled":true},{"key":"CompanyCode","value":"","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"ForbidUsernameAsCommunication","value":"false","description":"As per UpsertParty
\n","type":"text","disabled":true},{"key":"LinkCompany","value":"true","description":"OPTIONAL true/false - set to ‘true’ and add the following parameters to link company
\n","type":"text"},{"key":"CompanyCode","value":"","description":"OPTIONAL (usually partyid) of the company you want this person associated with
\n","type":"text","disabled":true},{"key":"CompanyAdditionalCodeType","value":"CRM_Company_Id","description":"OPTIONAL additionalcode type for searching on company
\n","type":"text"},{"key":"CompanyAdditionalCode","value":"1","description":"OPTIONAL additionalcode for searching on company
\n","type":"text"},{"key":"CompanyName","value":"Company 1xxxxxxxxxx - UpsertContactTest","description":"OPTIONAL search for company name
\n","type":"text"},{"key":"ValidationStatus","value":"","description":"OPTIONAL after linking, validation status will be updated. Values can be VALIDATED, VALIDATEDMANUAL, VALIDATEDDOMAIN, REJECTED, NON-VALIDATED, NOTDEFINED. Default if not supplied is NON-VALIDATED.
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpsertPartyWithAdditionalCode/{{version}}","urlObject":{"protocol":"https","path":["User","UpsertPartyWithAdditionalCode","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f99b1eef-2ec2-42ef-94e3-f94f35055246"},{"name":"UpsertPartyWithCredentials","id":"718e2b7c-d6d8-4b5f-a935-7bb61badbd62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"PartyID","value":"","description":"OPTIONAL - if this value is set, than API will try to update party with new data. If party has not been found for specified ID, or ID has not been specified, new party will be inserted
\n","type":"text","disabled":true},{"key":"PartyType","value":"","description":"REQUIRED - Possible values: \"Person\", \"Company\"
\n","type":"text"},{"key":"RecordStatus","value":"","description":"OPTIONAL - Possible values: \"Live\", \"Cancelled\", \"Deceased\", \"Inactive\", \"Merged\". Default is \"Live\"
\n","type":"text","disabled":true},{"key":"Title","value":"","description":"REQUIRED (if PartyType = Person) (or TitleId supplied)
\n","type":"text","disabled":true},{"key":"TitleId","value":"","description":"REQUIRED (if PartyType = Person) (or Title supplied)
\n","type":"text","disabled":true},{"key":"Forename","value":"","description":"REQUIRED (if PartyType = Person)
\n","type":"text"},{"key":"Surname","value":"","description":"REQUIRED (if PartyType = Person)
\n","type":"text"},{"key":"Suffix","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"DateOfBirth","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Deceased","value":"","description":"OPTIONAL - Possible values: \"Living\", \"Deceased\"
\n","type":"text","disabled":true},{"key":"GenderId","value":"","description":"OPTIONAL - Possible values: \"Male\", \"Female\", \"Unknown\"
\n","type":"text","disabled":true},{"key":"NiNumber","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"MiddleInitial","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Salutation","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Fullname","value":"","description":"REQUIRED (if PartyType = Company) - If party is a company this field is mandatory. If a person this is not required and will not be used
\n","type":"text","disabled":true},{"key":"CompanyName","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"RegisteredNumber","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"TradingStatus","value":"","description":"OPTIONAL - Company trading status. Possible values: \"Trading\", \"NotSet\", \"CeasedTrading\", \"Closed\", \"Liquidated\", \"BoughtOut\". Default is \"Trading\"
\n","type":"text","disabled":true},{"key":"AnnualTurnover","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"NumberOfEmployees","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"VatNumber","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"IndustryCode","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"IsBureau","value":"","description":"OPTIONAL - true/false
\n","type":"text","disabled":true},{"key":"SourceCodesCsv","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"DeleteMissingSourceCode","value":"","description":"OPTIONAL - where false sourcecodes are not removed when the party upsert is completed
\n","type":"text","disabled":true},{"key":"CompanyCode","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"ForbidUsernameAsCommunication","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"email","value":"","description":"REQUIRED - This is NOT recorded as an email communication entry on the party. It is included in the request to support matching against existing usernames OR email communication entries in AD when upserting the party via this API call.
\n","type":"text"},{"key":"username","value":"","description":"REQUIRED
\n","type":"text"},{"key":"password","value":"","description":"REQUIRED
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/UpsertPartyWithCredentials/{{version}}","description":"Insert new or update existing party.
\nParty for update will be matched by email (as username or any other associated e-mail address).
\nBesides updating party details, this method also offers the possibility to create new credentials or update existing set of credentials for matched party.
\n","urlObject":{"protocol":"https","path":["User","UpsertPartyWithCredentials","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"718e2b7c-d6d8-4b5f-a935-7bb61badbd62"},{"name":"UpsertCommunication","id":"78e71717-5e48-4c9c-9406-274afdb79be2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"UserToken","value":"","description":"REQUIRED (or partyAdditionalCode.) - If partyAdditionalCode. is also provided, the additional code matching will be attempted first. If party cannot be found using this, the UserToken value will be used.
\nException is if more than one party matches provided additional code. In this case, if there is only one active party, then this party will be used. If there is more than one party, error will be returned. If there are multiple parties, but none active, error will be thrown.
\n","type":"text"},{"key":"partyAdditionalCode.AdditionalCodeTypeName","value":"","description":"REQUIRED (or UserToken) - party additional code type
\n","type":"text","disabled":true},{"key":"partyAdditionalCode.Code","value":"","description":"REQUIRED (or UserToken)
\n","type":"text","disabled":true},{"key":"partyAdditionalCode.SubjectType","value":"","description":"REQUIRED (or UserToken) - possible values: \"Party\", \"Address\", \"Communication\". For party insert update, use Party subject type.
\n","type":"text","disabled":true},{"key":"communication.CommunicationTypeId","value":"","description":"REQUIRED - possible values: \"1\" - Email, \"2\" - Phone, \"3\" - Mobile, \"4\" - Web, \"5\" - Fax, \"9\" - Letter, \"10\" - DX number, \"11\" - DX exchange
\n","type":"text"},{"key":"communication.Communication","value":"","description":"REQUIRED - this is the value - phone number, email address etc.
\n","type":"text"},{"key":"communication.RecordStatus","value":"","description":"OPTIONAL - possible values: \"0\" - Live, \"1\" - Cancelled, \"2\" - Deleted. Default is live
\n","type":"text","disabled":true},{"key":"communication.FxBrandId","value":"","description":"OPTIONAL (although recommended) - Determines the AD brand the email is associated with
\n","type":"text","disabled":true},{"key":"communicationAdditionalCode.AdditionalCodeTypeName","value":"","description":"REQUIRED (if supplying communicationAdditionalCode.*)
\n","type":"text","disabled":true},{"key":"communicationAdditionalCode.Code","value":"","description":"REQUIRED (if supplying communicationAdditionalCode.*)
\n","type":"text","disabled":true},{"key":"communicationAdditionalCode.SubjectType","value":"Communication","description":"REQUIRED (if supplying communicationAdditionalCode.*) - Use Communication subject type.
\n","type":"text","disabled":true},{"key":"communicationAdditionalCode.ForbidAddingDuplicateValue","value":"","description":"OPTIONAL - true/false, default false. If false, duplicated additional codes will be attached to party. If true, additional codes that are already attached to party will not be added again.
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpsertCommunication/{{version}}","description":"Communication will be UPDATED in the following cases:
\na. If 'communicationAdditionalCode.Code' is provided and this code matches a previously added 'communication' where the same code was supplied.
\nb. If communication additional code is NOT provided, but party has communication the same communication type and communication value.
\nIf the above conditions are not met the communication item will be added as a new entry for the party. This will become the 'latest' value for the communication type for the party.
\n","urlObject":{"protocol":"https","path":["User","UpsertCommunication","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"78e71717-5e48-4c9c-9406-274afdb79be2"},{"name":"DoesPartyBelongToBI","id":"79d07b1a-a2e9-4f7e-9b95-58ae4b87ba04","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"},{"key":"FormId","value":"","description":"REQUIRED - The BI query id value (not name)
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/DoesPartyBelongToBI/{{version}}","description":"Checks if user belongs to specified BI filter.
\n","urlObject":{"protocol":"https","path":["User","DoesPartyBelongToBI","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"79d07b1a-a2e9-4f7e-9b95-58ae4b87ba04"},{"name":"AddAdditonalCodeForParty","id":"43c9ddee-266e-4530-a087-076c073912d1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyId) - Selects the party to be updated.
\n","type":"text"},{"key":"partyId","value":"","description":"REQUIRED (or userToken) - Selects the party to be updated.
\n","type":"text","disabled":true},{"key":"AdditionalCodeTypeName","value":"","description":"REQUIRED
\n","type":"text"},{"key":"Code","value":"","description":"REQUIRED - additional code value
\n","type":"text"},{"key":"SubjectType","value":"","description":"OPTIONAL - additional code subject type. Always use Party for this field.
\n","type":"text","disabled":true},{"key":"ForbidAddingDuplicateValue","value":"","description":"OPTIONAL - true/false, default false. If false, duplicated additional codes will be attached to party. If true, additional codes that are already attached to party will not be added again
\n","type":"text","disabled":true},{"key":"RecordStatus","value":"","description":"REQUIRED - possible values: \"Live\", \"Deleted\"
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/AddAdditonalCodeForParty/{{version}}","description":"This API allows adding additional code for a party.
\n","urlObject":{"protocol":"https","path":["User","AddAdditonalCodeForParty","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"43c9ddee-266e-4530-a087-076c073912d1"},{"name":"GetListOfAvailableProducts","id":"c8e0f660-2df0-49bc-afd1-419b5ba6c542","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyId)
\n","type":"text"},{"key":"partyId","value":"","description":"REQUIRED (or userToken)
\n","type":"text"},{"key":"brandId","value":"","description":"REQUIRED
\n","type":"text"},{"key":"ipAddress","value":"","description":"OPTIONAL (although RECOMMENDED) - Retrieves products where qualified by the supplied IP value
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/GetListOfAvailableProducts/{{version}}","description":"This API will retrieve all available products for party on specified brand. The response includes details of content item entitlement rules for the product.
\n","urlObject":{"protocol":"https","path":["User","GetListOfAvailableProducts","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"c8e0f660-2df0-49bc-afd1-419b5ba6c542"},{"name":"InsertCustomAttributes","id":"9d70a281-9d7d-4c31-bcc4-e705e59713aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"},{"key":"CustomAttributes","value":"","description":"REQUIRED - XML structure (multiple attributes & answers supported in one request) :\n\n \n QuestionCode1\n \n AnswerCodeABC\n \n \n \n QuestionCode2\n \n AnswerCodePQR\n AnswerCodeXYZ\n \n \n
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/InsertCustomAttributes/{{version}}","description":"The service is used to insert custom attributes to party.
\nThe request selects the party by 'userToken'. See '/InsertCustomAttributesForParty' if you wish to use 'partyId' instead.
\n","urlObject":{"protocol":"https","path":["User","InsertCustomAttributes","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"9d70a281-9d7d-4c31-bcc4-e705e59713aa"},{"name":"InsertCustomAttributesForParty","id":"4207c6d9-cd88-460d-bbeb-446d214b49a4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"PartyId","value":"","description":"REQUIRED - User token obtained via the login methods
\n","type":"text"},{"key":"CustomAttributes","value":"","description":"REQUIRED - XML structure (multiple attributes & answers supported in one request)
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/InsertCustomAttributesForParty/{{version}}","description":"The service is used to insert custom attributes to party.
\nThe request selects the party by 'partyId'. See '/InsertCustomAttributes' if you wish to use 'userToken' instead.
\nQuestionCode1
\nAnswerCodeABC
\nQuestionCode2
\nAnswerCodePQR
AnswerCodeXYZ
REQUIRED (or AdditionalCodeTypeName + Code)
\n","type":"text"},{"key":"AdditionalCodeTypeName","value":"","description":"REQUIRED (or partyId) - Party additional code type.
\n","type":"text","disabled":true},{"key":"Code","value":"","description":"REQUIRED (or partyId) - Additional code.
\n","type":"text","disabled":true},{"key":"SubjectType","value":"","description":"OPTIONAL - default is \"Party\"
\n","type":"text","disabled":true},{"key":"brandId","value":"","description":"REQUIRED
\n","type":"text"},{"key":"username","value":"","description":"REQUIRED - must be unique for provided brand.
\n","type":"text"},{"key":"Password","value":"","description":"REQUIRED
\n","type":"text"},{"key":"ForbidUsernameAsCommunication","value":"","description":"OPTIONAL - true/false, default false
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpsertUserCredentials/{{version}}","description":"This API will add credentials for a specified party.
\n","urlObject":{"protocol":"https","path":["User","UpsertUserCredentials","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"a711c520-f121-43f8-91fc-af4dc47a8760"},{"name":"UpsertPartyAddress","id":"3947b6dc-cc08-4f20-8ab6-b43664b84e23","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyAC.AdditionalCodeTypeName or addressAC.AdditionalCodeTypeName)
\nIf this and AdditionCode values are provided, userToken will be used.
\n","type":"text"},{"key":"partyAC.AdditionalCodeTypeName","value":"","description":"REQUIRED (or userToken or addressAC.AdditionalCodeTypeName) - Party additional code type.
\n","type":"text","disabled":true},{"key":"partyAC.Code","value":"","description":"REQUIRED (if supplying partyAC.AdditionalCodeTypeName) - Party additional code.
\n","type":"text","disabled":true},{"key":"addressAC.AdditionalCodeTypeName","value":"","description":"REQUIRED (or userToken or partyAC.AdditionalCodeTypeName) - Address additional code type.
\n","type":"text"},{"key":"addressAC.Code","value":"","description":"REQUIRED (if supplying addressAC.AdditionalCodeTypeName) - Address additional code.
\n","type":"text"},{"key":"addressAC.RecordStatus","value":"","description":"REQUIRED (if supplying addressAC.AdditionalCodeTypeName) - Status for address additional code. Live / Deleted
\n","type":"text"},{"key":"addressAC.ForbidAddingDuplicateValue","value":"","description":"OPTIONAL - true/false, default false
\n","type":"text","disabled":true},{"key":"Address1","value":"","description":"REQUIRED
\n","type":"text"},{"key":"Address2","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Address3","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Town","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"County","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"Postcode","value":"","description":"OPTIONAL
\n","type":"text","disabled":true},{"key":"CountryName","value":"","description":"REQUIRED
\n","type":"text"},{"key":"FxLocationName","value":"","description":"OPTIONAL (Company Name)
\n","type":"text","disabled":true},{"key":"LxLocationName","value":"","description":"OPTIONAL (Department name)
\n","type":"text","disabled":true},{"key":"LxLocationTitle","value":"","description":"OPTIONAL (Job title)
\n","type":"text","disabled":true},{"key":"RecordStatus","value":"","description":"OPTIONAL - possible values: \"Live\", \"Cancelled\", \"Deleted\", \"Inactive\". Default is \"Live\"
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/UpsertPartyAddress/{{version}}","description":"This API upserts address items to a party using userToken or party additional code.
\n","urlObject":{"protocol":"https","path":["User","UpsertPartyAddress","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3947b6dc-cc08-4f20-8ab6-b43664b84e23"},{"name":"GetLatestDPAList","id":"b420133f-36b2-44be-a7b5-6a045c427f02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"UserToken","value":"","description":"REQUIRED (or id)
\n","type":"text"},{"key":"id","value":"","description":"REQUIRED (or UserToken) - partyId
\n","type":"text","disabled":true},{"key":"scopes","value":"","description":"OPTIONAL - query string parameter as CSV format used to filter the result. Supports:\n ThirdParty\n Publisher\n Brand\n Product
\n","type":"text","disabled":true},{"key":"productsUids","value":"","description":"OPTIONAL - query string parameter as CSV format used to filter the result. List of integer values representing the IDs of products by which the result is expected to be filtered
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/GetLatestDPAList/{{version}}","description":"This method will retrieve DPA List for a party from the context brand, with option to filter by products.
\n","urlObject":{"protocol":"https","path":["User","GetLatestDPAList","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"b420133f-36b2-44be-a7b5-6a045c427f02"},{"name":"MergeParties","id":"402534c2-ce98-457a-a754-93533f541290","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"looserAdditionalCode","value":"","description":"REQUIRED - Identifies the party to merge FROM in the system by its associated additional code representing the external system identifier of that party. The type of this additional code is different for each client and is determined by publisher configuration setting “AdditionalCodeTypeForLegacyTranslation”
\n","type":"text"},{"key":"winnerAdditionalCode","value":"","description":"REQUIRED - Identifies the party to merge INTO in the system by its associated additional code representing the external system identifier of that party. The type of this additional code is different for each client and is determined by publisher configuration setting “AdditionalCodeTypeForLegacyTranslation”
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/MergeParties/{{version}}","description":"Used to merge 2 parties and keep only one party data (orders, credentials etc.).
\nThe 'looser' party will be set as “merged” party status in AD.
\n","urlObject":{"protocol":"https","path":["User","MergeParties","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"402534c2-ce98-457a-a754-93533f541290"},{"name":"Metadata (TryLogin)","id":"54468071-b464-4f96-ab0a-d7f2b094d837","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED - The userToken relating to the party user where metadata is to be requested.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/BEUser/TryLogin/{{version}}","description":"This method returns the AD datalayer which is used on frontend websites to expose user data elements to Google Analytics / Tag Manager. Response items are dependent on your AD datalayer configuration.
\nSee the following for further details on the datalayer functionality: https://www.abacuscloud.info/metadata-set-up-guide/147.article
\n","urlObject":{"protocol":"https","path":["BEUser","TryLogin","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"54468071-b464-4f96-ab0a-d7f2b094d837"},{"name":"InsertDPA","id":"072f23e7-ad01-4910-987d-b8089f85f836","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"Email","value":"","description":"REQUIRED (or UserToken) - Where the email matches multiple parties the DPA will be set for all matches.
\n","type":"text"},{"key":"UserToken","value":"","description":"REQUIRED (or Email)
\n","type":"text","disabled":true},{"key":"Channels","value":"","description":"OPTIONAL - CSV list of channels for which DPA should be inserted. Possible values:
\nEmail\nDirectMail\nTelephone\nSms\nFax\nOther
\nDefault value = Email
\n","type":"text","disabled":true},{"key":"Level","value":"","description":"REQUIRED - possible values: . Possible values: \"Publisher\", \"ThirdParty\", \"Brand\"
\n","type":"text"},{"key":"SourceCodes","value":"","description":"OPTIONAL - list of source codes to be attached to a party in case it is being created in (if e-mail cannot be matched). If source from list cannot be found, it will not be added to a party
\n","type":"text","disabled":true},{"key":"OkToUse","value":"","description":"OPTIONAL - true/false, default false - sets the status of whether contact is allowed via the DPA channel and level being updated.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/InsertDPA/{{version}}","description":"This service method inserts DPA for specified user.
\nWhere 'Email' is supplied without a 'UserToken', if the email cannot be found for an existing party a new party will be created.
\nNote: If 'Email' matches multiple parties, all will be updated with the specified DPA preference.
\n","urlObject":{"protocol":"https","path":["User","InsertDPA","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"072f23e7-ad01-4910-987d-b8089f85f836"},{"name":"GetPartyIdByEmail","id":"f19021fc-73f3-4656-961a-0af3038a4a59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"emailAddress","value":"","description":"REQUIRED - Party matching prioritises searching by 'username' first, then email communication values. If multiple matches only one party will be returned.
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/User/GetPartyIdByEmail/{{version}}","description":"Retrieves a 'partyId' value where the specified emailAddress value is matched to an existing party record.
\nMatching prioritises 'username' values, then 'email communication' entries.
\n","urlObject":{"protocol":"https","path":["User","GetPartyIdByEmail","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"f19021fc-73f3-4656-961a-0af3038a4a59"},{"name":"GetPartyFilteredBIResults","id":"bcb268b5-863d-4333-8b2d-fa6eb5cb973d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_RESPONSE_FORMAT","value":"json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyId)
\n","type":"text"},{"key":"partyId","value":"","description":"REQUIRED (or userToken)
\n","type":"text","disabled":true},{"key":"biQueryName","value":"","description":"REQUIRED - BI query name
\n","type":"text"}]},"url":"https://az-adapi.abacusemedia.com/BusinessIntelligence/GetPartyFilteredBIResults/{{version}}","description":"The service is used get the results of a BI Query filtered by the AD party determined by the 'userToken' or 'partyId' request value.
\n","urlObject":{"protocol":"https","path":["BusinessIntelligence","GetPartyFilteredBIResults","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"bcb268b5-863d-4333-8b2d-fa6eb5cb973d"},{"name":"GetPartyOrders","id":"3e0359ff-86dd-4c05-87af-0a87991b9836","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_RESPONSE_FORMAT","value":"json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"userToken","value":"","description":"REQUIRED (or partyId)
\n","type":"text"},{"key":"partyId","value":"","description":"REQUIRED (or userToken)
\n","type":"text","disabled":true},{"key":"ipAddress","value":"","description":"OPTIONAL (although RECOMMENDED)
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/GetPartyOrders/{{version}}","description":"Retrieves details of the specified party's orders.
\n","urlObject":{"protocol":"https","path":["User","GetPartyOrders","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"3e0359ff-86dd-4c05-87af-0a87991b9836"}],"id":"a11e7a99-e227-442f-b809-5981a28ce342","_postman_id":"a11e7a99-e227-442f-b809-5981a28ce342","description":""},{"name":"Company","item":[{"name":"GetLatestCompanyOrderByIPAddress","id":"62439736-55b0-41df-a05b-97568e51d273","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"}],"body":{"mode":"formdata","formdata":[{"key":"ipAddress","value":"","description":"REQUIRED - Get the latest corporate order granting access via this IP address
\n","type":"text"}]},"url":"{{domain}}/Company/GetLatestCompanyOrderByIPAddress/{{version}}","description":"Gets the latest company and live order associated with an IP address.
\n","urlObject":{"path":["Company","GetLatestCompanyOrderByIPAddress","{{version}}"],"host":["{{domain}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"62439736-55b0-41df-a05b-97568e51d273"},{"name":"GetLatestCompanyGetCompanyParties","id":"63ca17f9-02a8-473d-86a3-7563b224f95f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_RESPONSE_FORMAT","value":"json","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"companyId","value":"","description":"REQUIRED - the partyId of the company to retrieve linked users
\n","type":"text"},{"key":"latestCompany","value":"","description":"OPTIONAL - true/false - where true, only return linked individuals where their latest company link is for the queried companyId. Default is false.
\n","type":"text","disabled":true}]},"url":"https://az-adapi.abacusemedia.com/User/GetCompanyParties/{{version}}","description":"The service is used to get a list of individual party users who are linked to the company party specified in the request.
\n","urlObject":{"protocol":"https","path":["User","GetCompanyParties","{{version}}"],"host":["az-adapi.abacusemedia.com"],"query":[],"variable":[]}},"response":[],"_postman_id":"63ca17f9-02a8-473d-86a3-7563b224f95f"}],"id":"f76bb69c-1094-40d9-8a04-30c4c579fb14","_postman_id":"f76bb69c-1094-40d9-8a04-30c4c579fb14","description":""}],"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""],"id":"5dfe94ba-bf95-4cfa-af56-ba5fd9681234"}},{"listen":"test","script":{"type":"text/javascript","exec":[""],"id":"6951ec2e-4010-48df-a5e1-d2a84a311b87"}}],"variable":[{"key":"ADAPI_RESPONSE_FORMAT","value":"json"},{"key":"ADAPI_ACCESS_HASH","value":"000000-0000-0000-0000-0000000000000"},{"key":"ADAPI_ACCESS_TOKEN","value":"000000-0000-0000-0000-0000000000000"},{"key":"url-domain","value":"az-adapi.abacusemedia.com"}]}