WEBCentralizedShoppingCartAccreditationGetNew
|
Initial Build |
2017.1 |
|
xWeb |
xWeb Method |
|
Response Type |
XML |
This method retrieves an Accreditation record for a specified customer and Accreditation program.
Parameters
This method has the following required parameters:
OrganizatonCustomerKey (guid)—specify the organization/customer key in GUID format. The key must be a valid value in the system.
AccreditationProgramKey (guid)—specify the accreditation program key (ama_key) in GUID format. The key must be linked to the specified organization. This key is returned by the WEBCentralizedShoppingCartGetAccreditationList method.
Response
This method returns XML results for the Accreditation object based on the customer and accreditation area passed to it in the parameters, including the following elements:
- Accreditation and Accreditation Customer Keys
- Customer information
- Organization infromation
- Accreditation status
- Accreditation type
- Accreditation Survey Contact
- Decision Letter information
- Affiliations
- Invoice details
- Payment Information
Exceptions
This method returns an exception if either the OrganizationCustomerKey or the AccreditationProgramKey are invalid.
Sample Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.avectra.com/2005/">
<soapenv:Header>
<ns:AuthorizationToken>
<!--Optional:-->
<ns:Token>?</ns:Token>
</ns:AuthorizationToken>
</soapenv:Header>
<soapenv:Body>
<ns:WEBCentralizedShoppingCartAccreditationGetNew>
<ns:OrganizationCustomerKey>12fc5957-8ab9-46ba-89ad-30c846356bb4</ns:OrganizationCustomerKey>
<ns:AccreditationProgramKey>5fb6bf9a-0cda-4a7a-b8d0-723cbef2f0c6</ns:AccreditationProgramKey>
</ns:WEBCentralizedShoppingCartAccreditationGetNew>
</soapenv:Body>
</soapenv:Envelope>
Sample Response
Note: The following sample has been edited for brevity.
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<soap:Header>
<AuthorizationToken xmlns="http://www.avectra.com/2005/">
<Token>auth token displayed</Token> </AuthorizationToken>
</soap:Header>
<soap:Body>
<WEBCentralizedShoppingCartAccreditationGetNewResponse xmlns="http://www.avectra.com/2005/">
<WEBCentralizedShoppingCartAccreditationGetNewResult>
<Accreditation_Customer>
<amc_key>8e1bb095-f725-45e8-b30e-89e6f8586274</amc_key>
<amc_cst_key>12fc5957-8ab9-46ba-89ad-30c846356bb4</amc_cst_key>
<amc_key_ext>8e1bb095-f725-45e8-b30e-89e6f8586274</amc_key_ext>
<amc_ama_key>5fb6bf9a-0cda-4a7a-b8d0-723cbef2f0c6</amc_ama_key>
</Accreditation_Customer>
<Customer>
<cst_key>12fc5957-8ab9-46ba-89ad-30c846356bb4</cst_key>
<cst_type>Organization</cst_type>
<cst_name_cp>Abila</cst_name_cp>
<cst_sort_name_dn>Abila</cst_sort_name_dn>
<cst_ind_full_name_dn>Dr. Iryna K Mologoko</cst_ind_full_name_dn>
<cst_org_name_dn>Abila</cst_org_name_dn>
<cst_bio>For more than 17 years, we've been translating the business needs of associations, not-for-profits and member-based organizations into market-leading software and award-winning services. We automate your business, so you can focus on serving your members.</cst_bio>
<cst_add_date>2013-01-28T09:34:00-05:00</cst_add_date>
<cst_add_user>sgokina</cst_add_user>
<cst_change_date>2015-10-30T14:33:00-04:00</cst_change_date>
<cst_change_user>web:someemail@av.com</cst_change_user>
<cst_delete_flag>0</cst_delete_flag>
<cst_recno>88469</cst_recno>
<cst_id>000088469O</cst_id>
<cst_key_ext>12fc5957-8ab9-46ba-89ad-30c846356bb4</cst_key_ext>
<cst_email_text_only>0</cst_email_text_only>
<cst_tax_exempt_flag>0</cst_tax_exempt_flag>
<cst_cxa_key>b45b30d2-9295-4e08-88d9-b9ebf92417f1</cst_cxa_key>
<cst_no_email_flag>0</cst_no_email_flag>
<cst_cxa_billing_key>b45b30d2-9295-4e08-88d9-b9ebf92417f1</cst_cxa_billing_key>
<cst_eml_address_dn>someemail@av.com</cst_eml_address_dn>
<cst_eml_key>5921e80f-af3e-4147-8dd2-d7f03b90ac3a</cst_eml_key>
<cst_no_phone_flag>0</cst_no_phone_flag>
<cst_phn_number_complete_dn>703-506-7100 (222)</cst_phn_number_complete_dn>
<cst_cph_key>96206561-3872-4850-802a-4f8db50d0032</cst_cph_key>
<cst_no_fax_flag>0</cst_no_fax_flag>
<cst_fax_number_complete_dn>703-506-7700 (222)</cst_fax_number_complete_dn>
<cst_cfx_key>4fca26f2-f915-4eb0-9a2a-0dd1ca5ac284</cst_cfx_key>
<cst_ixo_key>13969bb5-909e-486c-807e-42658413ef1c</cst_ixo_key>
<cst_no_web_flag>0</cst_no_web_flag>
<cst_member_flag>1</cst_member_flag>
<cst_url_code_dn>http://www.avectra.com</cst_url_code_dn>
<cst_parent_cst_key>805ee77e-ead9-42e0-8467-a27ba3aa36e1</cst_parent_cst_key>
<cst_url_key>d697b33a-597a-44bd-ba49-4022061ec6a3</cst_url_key>
<cst_no_msg_flag>0</cst_no_msg_flag>
<cst_web_password>Qm7b0VkgopSU5z/LXTLEm9M/nQIDGo7g</cst_web_password>
<cst_no_mail_flag>0</cst_no_mail_flag>
<cst_web_force_password_change>1</cst_web_force_password_change>
<cst_web_login_disabled_flag>0</cst_web_login_disabled_flag>
<cst_credit_hold_flag>0</cst_credit_hold_flag>
<cst_web_forgot_password_status>0</cst_web_forgot_password_status>
<cst_no_publish_flag>0</cst_no_publish_flag>
<cst_sin_key>dc9b9ba2-89c3-4c3a-af05-467ca574364e</cst_sin_key>
<cst_jfn_key>ea3f93a4-4bc5-4447-8380-37cb09b43a0e</cst_jfn_key>
<cst_score>0.50</cst_score>
<cst_score_normalized>28</cst_score_normalized>
<cst_score_trend>0</cst_score_trend>
<cst_exclude_from_social_flag>0</cst_exclude_from_social_flag>
<cst_salt>wqotZgQ6I7kkIA4VqiygEys45D2Yeosk</cst_salt>
<cst_iterations>5000</cst_iterations>
</Customer>
<Customer_Address>
<cxa_cst_key>12fc5957-8ab9-46ba-89ad-30c846356bb4</cxa_cst_key>
<cxa_adr_key>f435485b-7ec7-4af3-9524-eacbafe52484</cxa_adr_key>
<cxa_add_date>2013-01-28T09:34:00-05:00</cxa_add_date>
<cxa_add_user>sgokina</cxa_add_user>
<cxa_change_date>2015-04-14T16:49:00-04:00</cxa_change_date>
<cxa_change_user>ddasbach</cxa_change_user>
<cxa_delete_flag>0</cxa_delete_flag>
<cxa_key>b45b30d2-9295-4e08-88d9-b9ebf92417f1</cxa_key>
<cxa_key_ext>b45b30d2-9295-4e08-88d9-b9ebf92417f1</cxa_key_ext>
<cxa_on_hold_flag>0</cxa_on_hold_flag>
<cxa_adt_key>7e4e2edd-4752-43fe-85a2-0c890378197a</cxa_adt_key>
<cxa_mailing_label>Abila 601 S Lake Destiny Dr 501 Maitland, FL 32751 UNITED STATES</cxa_mailing_label>
<cxa_mailing_label_html>Abila 601 S Lake Destiny Dr 401 Maitland, FL 3275 UNITED STATES </cxa_mailing_label_html>
</Customer_Address>
<Customer_Primary_Address>
<adr_key>f435485b-7ec7-4af3-9524-eacbafe52484</adr_key>
<adr_cst_key_owner>12fc5957-8ab9-46ba-89ad-30c846356bb4</adr_cst_key_owner>
<adr_line1>601 S Lake Destiny Dr</adr_line1>
<adr_line2>501</adr_line2>
<adr_city>Maitland</adr_city>
<adr_state>FL</adr_state>
<adr_post_code>32751</adr_post_code>
<adr_city_state_code>Maitland, FL 32751</adr_city_state_code>
<adr_country>UNITED STATES</adr_country>
<adr_add_date>2013-01-28T09:33:41-05:00</adr_add_date>
<adr_add_user>sgokina</adr_add_user>
<adr_change_date>2015-04-14T16:47:00-04:00</adr_change_date>
<adr_change_user>ddasbach</adr_change_user>
<adr_delete_flag>0</adr_delete_flag>
<adr_key_ext>f435485b-7ec7-4af3-9524-eacbafe52484</adr_key_ext>
<adr_bad_address_flag>0</adr_bad_address_flag>
<adr_no_validation_flag>0</adr_no_validation_flag>
</Customer_Primary_Address>
<Organization>
<org_consortia_flag>0</org_consortia_flag>
<org_cst_key>12fc5957-8ab9-46ba-89ad-30c846356bb4</org_cst_key>
<org_name>Abila</org_name>
<org_ogt_code>Corporation</org_ogt_code>
<org_cst_key_ext>12fc5957-8ab9-46ba-89ad-30c846356bb4</org_cst_key_ext>
<org_acronym>AVCTR</org_acronym>
<org_ind_cst_key>8740a1b3-a2a9-4a6c-9d70-91f39632802f</org_ind_cst_key>
<org_date_founded>3/19/1993 12:00:00 AM</org_date_founded>
<org_num_years_in_business_cp>22</org_num_years_in_business_cp>
<org_num_location>6</org_num_location>
<org_ownership_type>private</org_ownership_type>
<org_add_date>2013-01-28T09:34:00-05:00</org_add_date>
<org_nonprofit_flag>1</org_nonprofit_flag>
<org_add_user>sgokina</org_add_user>
<org_org_cst_key>9b49c1a7-6f22-4df2-ae35-505b3228df5a</org_org_cst_key>
<org_change_date>2015-10-29T14:09:31-04:00</org_change_date>
<org_change_user>kperez</org_change_user>
<org_delete_flag>0</org_delete_flag>
</Organization>
<Accreditation>
<ama_key>5fb6bf9a-0cda-4a7a-b8d0-723cbef2f0c6</ama_key>
<ama_code>12972 Test</ama_code>
<ama_desc>12972 Test</ama_desc>
<ama_add_user>sholliday</ama_add_user>
<ama_add_date>2014-09-02T00:00:00-04:00</ama_add_date>
<ama_delete_flag>0</ama_delete_flag>
<ama_key_ext>5fb6bf9a-0cda-4a7a-b8d0-723cbef2f0c6</ama_key_ext>
</Accreditation>
<Accreditation_Status/>
<Accreditation_Type/>
<Individual_Organization_CEO_Affiliation/>
<Affiliated_CEO/>
<Individual_Organization_CAO_Affiliation/>
<Affiliated_CAO/>
<Individual_Organization_CMOA_ffiliation/>
<Affiliated_CMO/>
<Individual_Organization_Survey_Contact_Affiliation/>
<Affiliated_Survey_Contact/>
<Individual_Decision_Letter_Recipient/>
<Decision_Letter_Recipient/>
<Invoice>
<inv_print_count>0</inv_print_count>
<inv_ship_priority>3</inv_ship_priority>
<inv_AutoRefund>0</inv_AutoRefund>
<inv_eweb_credit_available>0.00</inv_eweb_credit_available>
<inv_eweb_apply_credit_amount>0.00</inv_eweb_apply_credit_amount>
<inv_total>0.00</inv_total>
<inv_amount>0.00</inv_amount>
<inv_balance>0.00</inv_balance>
<inv_payment_to_apply_distributed>0.00</inv_payment_to_apply_distributed>
<inv_close_opportunity>0</inv_close_opportunity>
<inv_credit_to_apply_distributed>0.00</inv_credit_to_apply_distributed>
<inv_distributable_credit_total>0.00</inv_distributable_credit_total>
<inv_distributable_credit_balance>0.00</inv_distributable_credit_balance>
</Invoice>
<Payment/>
<Payment_Info>
<pin_isvault>0</pin_isvault>
<pin_tax_amt>0.00</pin_tax_amt>
<pin_billing_info_required_for_ach_flag>0</pin_billing_info_required_for_ach_flag>
</Payment_Info>
<Payment_Method/>
<Invoice_DetailCollection/>
</WEBCentralizedShoppingCartAccreditationGetNewResult>
</WEBCentralizedShoppingCartAccreditationGetNewResponse>
</soap:Body>
</soap:Envelope>
JSON Method
POST /xWeb/JSON/WEBCentralizedShoppingCartAccreditationGetNew
DATA: JSON
{
"WEBCentralizedShoppingCartAccreditationGetNew" : {
"OrganizationCustomerKey" : "12fc5957-8ab9-46ba-89ad-30c846356bb4",
"AccreditationProgramKey" : "5fb6bf9a-0cda-4a7a-b8d0-723cbef2f0c6"
}
}
SAMPLE RESULT
HTTP STATUS: 200
DATA: JSON
{
"AccreditationAreaType": {
"Accreditation_Customer": {
"amc_key": "02f20b60-1787-4c1a-bd3d-d05ffe88cdab",
"amc_cst_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"amc_key_ext": "02f20b60-1787-4c1a-bd3d-d05ffe88cdab",
"amc_ama_key": "d68697e9-2c08-4206-a7af-f7e8733ff8a3"
},
"Customer": {
"cst_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"cst_type": "Organization",
"cst_name_cp": "Keebler Corp",
"cst_sort_name_dn": "Keebler Corp",
"cst_org_name_dn": "Keebler Corp",
"cst_add_date": "2021-10-27T17:47:00+13:00",
"cst_add_user": "phil.roberts",
"cst_change_date": "2021-10-27T17:47:00+13:00",
"cst_change_user": "phil.roberts",
"cst_delete_flag": "0",
"cst_recno": "6927",
"cst_id": "000006927O",
"cst_key_ext": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"cst_email_text_only": "0",
"cst_tax_exempt_flag": "0",
"cst_no_email_flag": "0",
"cst_no_phone_flag": "0",
"cst_no_fax_flag": "0",
"cst_no_web_flag": "0",
"cst_member_flag": "0",
"cst_no_msg_flag": "0",
"cst_no_mail_flag": "0",
"cst_web_force_password_change": "0",
"cst_web_login_disabled_flag": "0",
"cst_credit_hold_flag": "0",
"cst_web_forgot_password_status": "0",
"cst_no_publish_flag": "0",
"cst_exclude_from_social_flag": "0",
"cst_web_login_locked_flag": "0"
},
"Customer_Address": null,
"Customer_Primary_Address": {
"adr_state": "VA",
"adr_country": "UNITED STATES"
},
"Organization": {
"org_consortia_flag": "0",
"org_cst_key": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"org_name": "Keebler Corp",
"org_cst_key_ext": "15ec7f25-9ce4-49a1-a60a-30a0517e387e",
"org_add_date": "2021-10-27T17:47:00+13:00",
"org_nonprofit_flag": "0",
"org_add_user": "phil.roberts",
"org_delete_flag": "0"
},
"Accreditation": {
"ama_key": "d68697e9-2c08-4206-a7af-f7e8733ff8a3",
"ama_code": "NAEYC Accreditation",
"ama_desc": "NAEYC Accreditation",
"ama_add_user": "joanna.szarko",
"ama_add_date": "2021-02-18T00:00:00+13:00",
"ama_change_user": "joanna.szarko",
"ama_change_date": "2021-02-18T00:00:00+13:00",
"ama_delete_flag": "0",
"ama_key_ext": "d68697e9-2c08-4206-a7af-f7e8733ff8a3"
},
"Accreditation_Status": null,
"Accreditation_Type": null,
"Individual_Organization_CEO_Affiliation": null,
"Affiliated_CEO": null,
"Individual_Organization_CAO_Affiliation": null,
"Affiliated_CAO": null,
"Individual_Organization_CMOA_ffiliation": null,
"Affiliated_CMO": null,
"Individual_Organization_Survey_Contact_Affiliation": null,
"Affiliated_Survey_Contact": null,
"Individual_Decision_Letter_Recipient": null,
"Decision_Letter_Recipient": null,
"Invoice": {
"inv_print_count": "0",
"inv_ship_priority": "3",
"inv_AutoRefund": "0",
"inv_eweb_credit_available": "0.00",
"inv_eweb_apply_credit_amount": "0.00",
"inv_total": "0.00",
"inv_amount": "0.00",
"inv_balance": "0.00",
"inv_payment_to_apply_distributed": "0.00",
"inv_close_opportunity": "0",
"inv_credit_to_apply_distributed": "0.00",
"inv_distributable_credit_total": "0.00",
"inv_distributable_credit_balance": "0.00",
"inv_paid_by_liability_balance": "0.00",
"inv_nettotal": "0.00",
"inv_netpayment": "0.00",
"inv_credit_to_apply": "0.00",
"inv_netbalance": "0.00",
"inv_netcredit": "0.00",
"inv_netunpaidbalance": "0.00",
"inv_netwriteoff": "0.00",
"inv_writeoff_to_apply": "0.00",
"inv_netreturn": "0.00",
"inv_return_to_apply": "0.00",
"inv_netapplied": "0.00",
"inv_previous_netapplied": "0.00",
"inv_previous_netpayment": "0.00",
"inv_total_to_apply": "0.00",
"inv_allow_payment_with_frozen_payment_method": "0",
"inv_select_all": "0",
"inv_autoapply": "0",
"inv_autoapplypayment": "0",
"inv_installment_flag": "0",
"inv_coe_flag": "0",
"inv_shippable_total": "0.00",
"inv_unapplied_shipping_total": "0.00",
"inv_shippable_items_flag": "0",
"inv_autoapplycredit": "0",
"inv_bill_me": "0",
"inv_HasNewLineItems": "0",
"inv_HasOldLineItems": "0",
"inv_total_weight": "0.00",
"inv_discount": "0.00",
"inv_shipping": "0.00",
"inv_tax": "0.00"
},
"Payment": null,
"Payment_Info": {
"pin_hosted_page_available": "0",
"pin_mobile_app_available": "0",
"pin_hosted_payment": "0",
"pin_isvault": "0",
"pin_tax_amt": "0.00",
"pin_billing_info_required_for_ach_flag": "0",
"pin_allow_online_payment_flag": "0",
"pin_preferred_flag": "0"
},
"Payment_Method": null,
"Invoice_DetailCollection": null
}
}