Package: api-tester-upload-test
Getting Started with TesterTesting various
api
featuresBuildingYou must have Python2 >=2.7.9or Python3 >=3.4installed on your system to install and run this SDK. This SDK package depends on other Python packages like nose, jsonpickle etc. These dependencies are defined in therequirements.txtfile that comes with the SDK.To resolve these dependencies, you can use the PIP Dependency manager. Install it by following steps athttps://pip.pypa.io/en/stable/installing/.Python and PIP executables should be defined in your PATH. Open command prompt and typepip --version. This should display the version of the PIP Dependency Manager installed if your installation was successful and the paths are properly defined.Using command line, navigate to the directory containing the generated files (includingrequirements.txt) for the SDK.Run the commandpip install -r requirements.txt. This should install all the required dependencies.InstallationThe following section explains how to use the tester library in a new project.1. Open Project in an IDEOpen up a Python IDE like PyCharm. The basic workflow presented here is also applicable if you prefer using a different editor or IDE.Click onOpenin PyCharm to browse to your generated SDK directory and then clickOK.The project files will be displayed in the side bar as follows:2. Add a new Test ProjectCreate a new directory by right clicking on the solution name as shown below:Name the directory as "test".Add a python file to this project.Name it "testSDK".In your python file you will be required to import the generated python library using the following code linesfromtester.tester_clientimportTesterClientAfter this you can write code to instantiate an API client object, get a controller object and  make API calls. Sample code is given in the subsequent sections.3. Run the Test ProjectTo run the file within your test project, right click on your Python file inside your Test project and click onRunTestingYou can test the generated SDK and the server with automatically generated test cases.unittestis used as the testing framework andnoseis used as the test runner. You can run the tests as follows:From terminal/cmd navigate to the root directory of the SDK.Invokepip install -r test-requirements.txtInvokenosetestsUsageTo initialize the API client, the following parameters need to be passed.ParameterTypeDescriptionportstringDefault:'80'suitesSuiteCodeDefault:1The API client can be initialized using a Configuration object as following.client=TesterClient(# Set the environmentenvironment=Environment.TESTING,# Set configuration parametersport='80',suites=SuiteCode.HEARTS,)EnvironmentsThe SDK can be configured to use a different environment for making API calls. Available environments are:NameValueDescriptionproductionPRODUCTIONtestingTESTINGDefaultAuthorizationThis API does not require authentication.API ErrorsHere is the list of errors that the API might throw.HTTP Status CodeError DescriptionException Class400400 GlobalAPIException402402 GlobalAPIException403403 GlobalAPIException404404 GlobalAPIException412Precondition FailedNestedModelException450caught global exceptionCustomErrorResponseException452global exception with stringExceptionWithStringException453boolean in global exceptionExceptionWithBooleanException454dynamic in global exceptionExceptionWithDynamicException455uuid in global exceptionExceptionWithUUIDException456date in global exceptionExceptionWithDateException457number in global  exceptionExceptionWithNumberException458long in global exceptionExceptionWithLongException459precision in global  exceptionExceptionWithPrecisionException460rfc3339 in global exceptionExceptionWithRfc3339DateTimeException461unix time stamp in global exceptionUnixTimeStampException462rfc1123 in global exceptionRfc1123Exception463boolean in model as global exceptionSendBooleanInModelAsException464rfc3339 in model as global exceptionSendRfc3339InModelAsException465rfc1123 in model as global exceptionSendRfc1123InModelAsException466unix time stamp in model as global exceptionSendUnixTimeStampInModelAsException467send date in model as global exceptionSendDateInModelAsException468send dynamic in model as global exceptionSendDynamicInModelAsException469send string in model as global exceptionSendStringInModelAsException470send long in model as global exceptionSendLongInModelAsException471send number in model as global exceptionSendNumberInModelAsException472send precision in model as global exceptionSendPrecisionInModelAsException473send uuid in model as global exceptionSendUuidInModelAsException500500 GlobalGlobalTestExceptionDefaultInvalid response.GlobalTestExceptionAPI ReferenceList of APIsResponse TypesForm ParamsBody ParamsError CodesQuery ParamEchoHeaderTemplate ParamsQuery ParamsResponseTypesControllerOverviewGet instanceAn instance of theResponseTypesControllerclass can be accessed from the API Client.response_types_controller = client.response_typesget_date_arraydefget_date_array(self)Response TypeList of dateExample Usageresult=response_types_controller.get_date_array()get_datedefget_date(self)Response TypedateExample Usageresult=response_types_controller.get_date()return_company_modeldefreturn_company_model(self)Response TypeCompanyExample Usageresult=response_types_controller.return_company_model()Example Response(as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601"}return_boss_modeldefreturn_boss_model(self)Response TypeBossCompanyExample Usageresult=response_types_controller.return_boss_model()Example Response(as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Adeel","last name":"Ali","address_boss":"nust"}return_employee_modeldefreturn_employee_model(self)Response TypeEmployeeCompExample Usageresult=response_types_controller.return_employee_model()Example Response(as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Nauman","last name":"Ali","id":"123456"}return_developer_modeldefreturn_developer_model(self)Response TypeDeveloperExample Usageresult=response_types_controller.return_developer_model()Example Response(as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Nauman","last name":"Ali","id":"123456","team":"CORE","designation":"Manager","role":"Team Lead"}return_tester_modeldefreturn_tester_model(self)Response TypeSoftwareTesterExample Usageresult=response_types_controller.return_tester_model()Example Response(as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Muhammad","last name":"Farhan","id":"123456","team":"Testing","designation":"Tester","role":"Testing"}return_complex_1_objectdefreturn_complex_1_object(self)Response TypeComplex1Example Usageresult=response_types_controller.return_complex_1_object()Example Response(as JSON){"medications":[{"aceInhibitors":[{"name":"lisinopril","strength":"10 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"antianginal":[{"name":"nitroglycerin","strength":"0.4 mg Sublingual Tab","dose":"1 tab","route":"SL","sig":"q15min PRN","pillCount":"#30","refills":"Refill 1"}],"anticoagulants":[{"name":"warfarin sodium","strength":"3 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"betaBlocker":[{"name":"metoprolol tartrate","strength":"25 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"diuretic":[{"name":"furosemide","strength":"40 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"mineral":[{"name":"potassium chloride ER","strength":"10 mEq Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}]}],"labs":[{"name":"Arterial Blood Gas","time":"Today","location":"Main Hospital Lab"},{"name":"BMP","time":"Today","location":"Primary Care Clinic"},{"name":"BNP","time":"3 Weeks","location":"Primary Care Clinic"},{"name":"BUN","time":"1 Year","location":"Primary Care Clinic"},{"name":"Cardiac Enzymes","time":"Today","location":"Primary Care Clinic"},{"name":"CBC","time":"1 Year","location":"Primary Care Clinic"},{"name":"Creatinine","time":"1 Year","location":"Main Hospital Lab"},{"name":"Electrolyte Panel","time":"1 Year","location":"Primary Care Clinic"},{"name":"Glucose","time":"1 Year","location":"Main Hospital Lab"},{"name":"PT/INR","time":"3 Weeks","location":"Primary Care Clinic"},{"name":"PTT","time":"3 Weeks","location":"Coumadin Clinic"},{"name":"TSH","time":"1 Year","location":"Primary Care Clinic"}],"imaging":[{"name":"Chest X-Ray","time":"Today","location":"Main Hospital Radiology"},{"name":"Chest X-Ray","time":"Today","location":"Main Hospital Radiology"},{"name":"Chest X-Ray","time":"Today","location":"Main Hospital Radiology"}]}return_response_with_enumsdefreturn_response_with_enums(self)Response TypeResponseWithEnumExample Usageresult=response_types_controller.return_response_with_enums()Example Response(as JSON){"paramFormat":"Template","optional":false,"type":"Long","constant":false,"isArray":false,"isStream":false,"isAttribute":false,"isMap":false,"attributes":{"exclusiveMaximum":false,"exclusiveMinimum":false,"id":"5a9fcb01caacc310dc6bab51"},"nullable":false,"id":"5a9fcb01caacc310dc6bab50","name":"petId","description":"ID of pet to update"}return_complex_2_objectdefreturn_complex_2_object(self)Response TypeComplex2Example Usageresult=response_types_controller.return_complex_2_object()Example Response(as JSON){"glossary":{"title":"example glossary","GlossDiv":{"title":"S","GlossList":{"GlossEntry":{"ID":"SGML","SortAs":"SGML","GlossTerm":"Standard Generalized Markup Language","Acronym":"SGML","Abbrev":"ISO 8879:1986","GlossDef":{"para":"A meta-markup language, used to create markup languages such as DocBook.","GlossSeeAlso":["GML","XML"]},"GlossSee":"markup"}}}}}return_complex_3_objectdefreturn_complex_3_object(self)Response TypeComplex3Example Usageresult=response_types_controller.return_complex_3_object()Example Response(as JSON){"documentId":"099cceda-38a8-4b01-87b9-a8f2007675d6","signers":[{"id":"1bef97d1-0704-4eb2-a490-a8f2007675db","url":"https://sign-test.idfy.io/start?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzM4NCJ9.eyJrdmVyc2lvbiI6IjdmNzhjNzNkMmQ1MjQzZWRiYjdiNDI0MmI2MDE1MWU4IiwiZG9jaWQiOiIwOTljY2VkYS0zOGE4LTRiMDEtODdiOS1hOGYyMDA3Njc1ZDYiLCJhaWQiOiJjMGNlMTQ2OC1hYzk0LTRiMzQtODc2ZS1hODg1MDBjMmI5YTEiLCJsZyI6ImVuIiwiZXJyIjpudWxsLCJpZnIiOmZhbHNlLCJ3Ym1zZyI6ZmFsc2UsInNmaWQiOiIxYmVmOTdkMS0wNzA0LTRlYjItYTQ5MC1hOGYyMDA3Njc1ZGIiLCJ1cmxleHAiOm51bGwsImF0aCI6bnVsbCwiZHQiOiJUZXN0IGRvY3VtZW50IiwidmYiOmZhbHNlLCJhbiI6IklkZnkgU0RLIGRlbW8iLCJ0aCI6IlBpbmsiLCJzcCI6IkN1YmVzIiwiZG9tIjpudWxsLCJyZGlyIjpmYWxzZSwidXQiOiJ3ZWIiLCJ1dHYiOm51bGwsInNtIjoidGVzdEB0ZXN0LmNvbSJ9.Dyy2RSeR6dmU8qxOEi-2gEX3Gg7wry6JhkZIWOuADDdu5jJWidQLcxfJn_qAHNpb","links":[],"externalSignerId":"uoiahsd321982983jhrmnec2wsadm32","redirectSettings":{"redirectMode":"donot_redirect"},"signatureType":{"mechanism":"pkisignature","onEacceptUseHandWrittenSignature":false},"ui":{"dialogs":{"before":{"useCheckBox":false,"title":"Info","message":"Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."}},"language":"EN","styling":{"colorTheme":"Pink","spinner":"Cubes"}},"tags":[],"order":0,"required":false}],"status":{"documentStatus":"unsigned","completedPackages":[],"attachmentPackages":{}},"title":"Test document","description":"This is an important document","externalId":"ae7b9ca7-3839-4e0d-a070-9f14bffbbf55","dataToSign":{"fileName":"sample.txt","convertToPDF":false},"contactDetails":{"email":"test@test.com","url":"https://idfy.io"},"advanced":{"tags":["develop","fun_with_documents"],"attachments":0,"requiredSignatures":0,"getSocialSecurityNumber":false,"timeToLive":{"deadline":"2018-06-29T14:57:25Z","deleteAfterHours":1}}}get_longdefget_long(self)Response Typelong|intExample Usageresult=response_types_controller.get_long()get_modeldefget_model(self)Response TypePersonExample Usageresult=response_types_controller.get_model()get_string_enum_arraydefget_string_enum_array(self)Response TypeList of DaysExample Usageresult=response_types_controller.get_string_enum_array()get_string_enumdefget_string_enum(self)Response TypeDaysExample Usageresult=response_types_controller.get_string_enum()get_model_arraydefget_model_array(self)Response TypeList of PersonExample Usageresult=response_types_controller.get_model_array()get_int_enumdefget_int_enum(self)Response TypeSuiteCodeExample Usageresult=response_types_controller.get_int_enum()get_int_enum_arraydefget_int_enum_array(self)Response TypeList of SuiteCodeExample Usageresult=response_types_controller.get_int_enum_array()get_precisiondefget_precision(self)Response TypefloatExample Usageresult=response_types_controller.get_precision()get_binarygets a binary objectdefget_binary(self)Response TypebinaryExample Usageresult=response_types_controller.get_binary()get_integerGets a integer responsedefget_integer(self)Response TypeintExample Usageresult=response_types_controller.get_integer()get_integer_arrayGet an array of integers.defget_integer_array(self)Response TypeList of intExample Usageresult=response_types_controller.get_integer_array()get_dynamicdefget_dynamic(self)Response TypemixedExample Usageresult=response_types_controller.get_dynamic()get_dynamic_arraydefget_dynamic_array(self)Response TypemixedExample Usageresult=response_types_controller.get_dynamic_array()get_3339_datetimedefget_3339_datetime(self)Response TypedatetimeExample Usageresult=response_types_controller.get_3339_datetime()get_3339_datetime_arraydefget_3339_datetime_array(self)Response TypeList of datetimeExample Usageresult=response_types_controller.get_3339_datetime_array()get_booleandefget_boolean(self)Response TypeboolExample Usageresult=response_types_controller.get_boolean()get_boolean_arraydefget_boolean_array(self)Response TypeList of boolExample Usageresult=response_types_controller.get_boolean_array()get_headersdefget_headers(self)Response TypevoidExample Usageresult=response_types_controller.get_headers()get_1123_date_timedefget_1123_date_time(self)Response TypedatetimeExample Usageresult=response_types_controller.get_1123_date_time()get_unix_date_timedefget_unix_date_time(self)Response TypedatetimeExample Usageresult=response_types_controller.get_unix_date_time()get_1123_date_time_arraydefget_1123_date_time_array(self)Response TypeList of datetimeExample Usageresult=response_types_controller.get_1123_date_time_array()get_unix_date_time_arraydefget_unix_date_time_array(self)Response TypeList of datetimeExample Usageresult=response_types_controller.get_unix_date_time_array()get_content_type_headersdefget_content_type_headers(self)Response TypevoidExample Usageresult=response_types_controller.get_content_type_headers()FormParamsControllerOverviewGet instanceAn instance of theFormParamsControllerclass can be accessed from the API Client.form_params_controller = client.form_paramssend_delete_formdefsend_delete_form(self,body)ParametersParameterTypeTagsDescriptionbodyDeleteBodyForm, Required-Response TypeServerResponseExample Usagebody=DeleteBody()()body.name='name6'body.field='field0'result=form_params_controller.send_delete_form(body)send_delete_multipartdefsend_delete_multipart(self,file)ParametersParameterTypeTagsDescriptionfilestringForm, Required-Response TypeServerResponseExample Usagefile=open('dummy_file','r')result=form_params_controller.send_delete_multipart(file)send_date_arraydefsend_date_array(self,dates)ParametersParameterTypeTagsDescriptiondatesList of dateForm, Required-Response TypeServerResponseExample Usagedates=[dateutil.parser.parse('2016-03-13').date(),dateutil.parser.parse('2016-03-13').date()]result=form_params_controller.send_date_array(dates)send_datedefsend_date(self,date)ParametersParameterTypeTagsDescriptiondatedateForm, Required-Response TypeServerResponseExample Usagedate=dateutil.parser.parse('2016-03-13').date()result=form_params_controller.send_date(date)send_unix_date_timedefsend_unix_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeForm, Required-Response TypeServerResponseExample Usagedatetime=dt.datetime.utcfromtimestamp(1480809600)result=form_params_controller.send_unix_date_time(datetime)send_rfc_1123_date_timedefsend_rfc_1123_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeForm, Required-Response TypeServerResponseExample Usagedatetime=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimeresult=form_params_controller.send_rfc_1123_date_time(datetime)send_rfc_3339_date_timedefsend_rfc_3339_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeForm, Required-Response TypeServerResponseExample Usagedatetime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')result=form_params_controller.send_rfc_3339_date_time(datetime)send_unix_date_time_arraydefsend_unix_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeForm, Required-Response TypeServerResponseExample Usagedatetimes=[dt.datetime.utcfromtimestamp(1480809600),dt.datetime.utcfromtimestamp(1480809600),dt.datetime.utcfromtimestamp(1480809600)]result=form_params_controller.send_unix_date_time_array(datetimes)send_rfc_1123_date_time_arraydefsend_rfc_1123_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeForm, Required-Response TypeServerResponseExample Usagedatetimes=[APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime,APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime,APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime]result=form_params_controller.send_rfc_1123_date_time_array(datetimes)send_longdefsend_long(self,value)ParametersParameterTypeTagsDescriptionvalue`longint`Form, RequiredResponse TypeServerResponseExample Usagevalue=64result=form_params_controller.send_long(value)send_integer_arraydefsend_integer_array(self,integers)ParametersParameterTypeTagsDescriptionintegersList of intForm, Required-Response TypeServerResponseExample Usageintegers=[45,46,47]result=form_params_controller.send_integer_array(integers)send_string_arraydefsend_string_array(self,strings)ParametersParameterTypeTagsDescriptionstringsList of stringForm, Required-Response TypeServerResponseExample Usagestrings=['strings5']result=form_params_controller.send_string_array(strings)allow_dynamic_form_fieldsdefallow_dynamic_form_fields(self,name,_optional_form_parameters=None)ParametersParameterTypeTagsDescriptionnamestringForm, Required-_optional_form_parametersarrayOptionalPass additional field parameters.Response TypeServerResponseExample Usagename='name0'_optional_form_parameters={'key0':'additionalFieldParams9'}result=form_params_controller.allow_dynamic_form_fields(name,_optional_form_parameters)send_modeldefsend_model(self,model)ParametersParameterTypeTagsDescriptionmodelEmployeeForm, Required-Response TypeServerResponseExample Usagemodel=Employee()()model.department='department8'model.dependents=[]model.dependents.append(Person())model.dependents[0].address='address5'model.dependents[0].age=237model.dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()model.dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.dependents[0].name='name9'model.dependents[0].uid='uid9'model.hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodel.joining_day=Days.TUESDAYmodel.salary=240model.working_days=[Days.THURSDAY,Days.WEDNESDAY_,Days.TUESDAY]model.address='address8'model.age=186model.birthday=dateutil.parser.parse('2016-03-13').date()model.birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.name='name2'model.uid='uid2'result=form_params_controller.send_model(model)send_model_arraydefsend_model_array(self,models)ParametersParameterTypeTagsDescriptionmodelsList of EmployeeForm, Required-Response TypeServerResponseExample Usagemodels=[]models.append(Employee())models[0].department='department6'models[0].dependents=[]models[0].dependents.append(Person())models[0].dependents[0].address='address9'models[0].dependents[0].age=49models[0].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[0].name='name3'models[0].dependents[0].uid='uid3'models[0].dependents.append(Person())models[0].dependents[1].address='address0'models[0].dependents[1].age=50models[0].dependents[1].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[1].name='name4'models[0].dependents[1].uid='uid4'models[0].dependents.append(Person())models[0].dependents[2].address='address1'models[0].dependents[2].age=51models[0].dependents[2].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[2].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[2].name='name5'models[0].dependents[2].uid='uid5'models[0].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[0].joining_day=Days.WEDNESDAY_models[0].salary=84models[0].working_days=[Days.SUNDAY]models[0].address='address2'models[0].age=254models[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].name='name6'models[0].uid='uid6'models.append(Employee())models[1].department='department7'models[1].dependents=[]models[1].dependents.append(Person())models[1].dependents[0].address='address0'models[1].dependents[0].age=50models[1].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[1].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].dependents[0].name='name4'models[1].dependents[0].uid='uid4'models[1].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[1].joining_day=Days.THURSDAYmodels[1].salary=85models[1].working_days=[Days.MONDAY,Days.TUESDAY]models[1].address='address3'models[1].age=255models[1].birthday=dateutil.parser.parse('2016-03-13').date()models[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].name='name7'models[1].uid='uid7'result=form_params_controller.send_model_array(models)send_filedefsend_file(self,file)ParametersParameterTypeTagsDescriptionfilestringForm, Required-Response TypeServerResponseExample Usagefile=open('dummy_file','r')result=form_params_controller.send_file(file)send_multiple_filesdefsend_multiple_files(self,file,file_1)ParametersParameterTypeTagsDescriptionfilestringForm, Required-file_1stringForm, Required-Response TypeServerResponseExample Usagefile=open('dummy_file','r')file_1=open('dummy_file','r')result=form_params_controller.send_multiple_files(file,file_1)send_stringdefsend_string(self,value)ParametersParameterTypeTagsDescriptionvaluestringForm, Required-Response TypeServerResponseExample Usagevalue='value2'result=form_params_controller.send_string(value)send_rfc_3339_date_time_arraydefsend_rfc_3339_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeForm, Required-Response TypeServerResponseExample Usagedatetimes=[dateutil.parser.parse('2016-03-13T12:52:32.123Z'),dateutil.parser.parse('2016-03-13T12:52:32.123Z'),dateutil.parser.parse('2016-03-13T12:52:32.123Z')]result=form_params_controller.send_rfc_3339_date_time_array(datetimes)send_mixed_arraySend a variety for form params. Returns file count and body paramsdefsend_mixed_array(self,options=dict())ParametersParameterTypeTagsDescriptionfilestringForm, Required-integersList of intForm, Required-modelsList of EmployeeForm, Required-stringsList of stringForm, Required-Response TypeServerResponseExample Usagecollect={}file=open('dummy_file','r')collect['file']=fileintegers=[45,46,47]collect['integers']=integersmodels=[]models.append(Employee())models[0].department='department6'models[0].dependents=[]models[0].dependents.append(Person())models[0].dependents[0].address='address9'models[0].dependents[0].age=49models[0].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[0].name='name3'models[0].dependents[0].uid='uid3'models[0].dependents.append(Person())models[0].dependents[1].address='address0'models[0].dependents[1].age=50models[0].dependents[1].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[1].name='name4'models[0].dependents[1].uid='uid4'models[0].dependents.append(Person())models[0].dependents[2].address='address1'models[0].dependents[2].age=51models[0].dependents[2].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[2].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[2].name='name5'models[0].dependents[2].uid='uid5'models[0].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[0].joining_day=Days.WEDNESDAY_models[0].salary=84models[0].working_days=[Days.SUNDAY]models[0].address='address2'models[0].age=254models[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].name='name6'models[0].uid='uid6'models.append(Employee())models[1].department='department7'models[1].dependents=[]models[1].dependents.append(Person())models[1].dependents[0].address='address0'models[1].dependents[0].age=50models[1].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[1].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].dependents[0].name='name4'models[1].dependents[0].uid='uid4'models[1].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[1].joining_day=Days.THURSDAYmodels[1].salary=85models[1].working_days=[Days.MONDAY,Days.TUESDAY]models[1].address='address3'models[1].age=255models[1].birthday=dateutil.parser.parse('2016-03-13').date()models[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].name='name7'models[1].uid='uid7'collect['models']=modelsstrings=['strings5']collect['strings']=stringsresult=form_params_controller.send_mixed_array(collect)update_model_with_formdefupdate_model_with_form(self,model)ParametersParameterTypeTagsDescriptionmodelEmployeeForm, Required-Response TypeServerResponseExample Usagemodel=Employee()()model.department='department8'model.dependents=[]model.dependents.append(Person())model.dependents[0].address='address5'model.dependents[0].age=237model.dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()model.dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.dependents[0].name='name9'model.dependents[0].uid='uid9'model.hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodel.joining_day=Days.TUESDAYmodel.salary=240model.working_days=[Days.THURSDAY,Days.WEDNESDAY_,Days.TUESDAY]model.address='address8'model.age=186model.birthday=dateutil.parser.parse('2016-03-13').date()model.birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.name='name2'model.uid='uid2'result=form_params_controller.update_model_with_form(model)send_delete_form_1defsend_delete_form_1(self,model)ParametersParameterTypeTagsDescriptionmodelEmployeeForm, Required-Response TypeServerResponseExample Usagemodel=Employee()()model.department='department8'model.dependents=[]model.dependents.append(Person())model.dependents[0].address='address5'model.dependents[0].age=237model.dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()model.dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.dependents[0].name='name9'model.dependents[0].uid='uid9'model.hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodel.joining_day=Days.TUESDAYmodel.salary=240model.working_days=[Days.THURSDAY,Days.WEDNESDAY_,Days.TUESDAY]model.address='address8'model.age=186model.birthday=dateutil.parser.parse('2016-03-13').date()model.birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.name='name2'model.uid='uid2'result=form_params_controller.send_delete_form_1(model)send_delete_form_with_model_arraydefsend_delete_form_with_model_array(self,models)ParametersParameterTypeTagsDescriptionmodelsList of EmployeeForm, Required-Response TypeServerResponseExample Usagemodels=[]models.append(Employee())models[0].department='department6'models[0].dependents=[]models[0].dependents.append(Person())models[0].dependents[0].address='address9'models[0].dependents[0].age=49models[0].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[0].name='name3'models[0].dependents[0].uid='uid3'models[0].dependents.append(Person())models[0].dependents[1].address='address0'models[0].dependents[1].age=50models[0].dependents[1].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[1].name='name4'models[0].dependents[1].uid='uid4'models[0].dependents.append(Person())models[0].dependents[2].address='address1'models[0].dependents[2].age=51models[0].dependents[2].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[2].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[2].name='name5'models[0].dependents[2].uid='uid5'models[0].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[0].joining_day=Days.WEDNESDAY_models[0].salary=84models[0].working_days=[Days.SUNDAY]models[0].address='address2'models[0].age=254models[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].name='name6'models[0].uid='uid6'models.append(Employee())models[1].department='department7'models[1].dependents=[]models[1].dependents.append(Person())models[1].dependents[0].address='address0'models[1].dependents[0].age=50models[1].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[1].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].dependents[0].name='name4'models[1].dependents[0].uid='uid4'models[1].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[1].joining_day=Days.THURSDAYmodels[1].salary=85models[1].working_days=[Days.MONDAY,Days.TUESDAY]models[1].address='address3'models[1].age=255models[1].birthday=dateutil.parser.parse('2016-03-13').date()models[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].name='name7'models[1].uid='uid7'result=form_params_controller.send_delete_form_with_model_array(models)update_model_array_with_formdefupdate_model_array_with_form(self,models)ParametersParameterTypeTagsDescriptionmodelsList of EmployeeForm, Required-Response TypeServerResponseExample Usagemodels=[]models.append(Employee())models[0].department='department6'models[0].dependents=[]models[0].dependents.append(Person())models[0].dependents[0].address='address9'models[0].dependents[0].age=49models[0].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[0].name='name3'models[0].dependents[0].uid='uid3'models[0].dependents.append(Person())models[0].dependents[1].address='address0'models[0].dependents[1].age=50models[0].dependents[1].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[1].name='name4'models[0].dependents[1].uid='uid4'models[0].dependents.append(Person())models[0].dependents[2].address='address1'models[0].dependents[2].age=51models[0].dependents[2].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[2].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[2].name='name5'models[0].dependents[2].uid='uid5'models[0].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[0].joining_day=Days.WEDNESDAY_models[0].salary=84models[0].working_days=[Days.SUNDAY]models[0].address='address2'models[0].age=254models[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].name='name6'models[0].uid='uid6'models.append(Employee())models[1].department='department7'models[1].dependents=[]models[1].dependents.append(Person())models[1].dependents[0].address='address0'models[1].dependents[0].age=50models[1].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[1].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].dependents[0].name='name4'models[1].dependents[0].uid='uid4'models[1].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[1].joining_day=Days.THURSDAYmodels[1].salary=85models[1].working_days=[Days.MONDAY,Days.TUESDAY]models[1].address='address3'models[1].age=255models[1].birthday=dateutil.parser.parse('2016-03-13').date()models[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].name='name7'models[1].uid='uid7'result=form_params_controller.update_model_array_with_form(models)update_string_with_formdefupdate_string_with_form(self,value)ParametersParameterTypeTagsDescriptionvaluestringForm, Required-Response TypeServerResponseExample Usagevalue='value2'result=form_params_controller.update_string_with_form(value)update_string_array_with_formdefupdate_string_array_with_form(self,strings)ParametersParameterTypeTagsDescriptionstringsList of stringForm, Required-Response TypeServerResponseExample Usagestrings=['strings5']result=form_params_controller.update_string_array_with_form(strings)send_integer_enum_arraydefsend_integer_enum_array(self,suites)ParametersParameterTypeTagsDescriptionsuitesList of SuiteCodeForm, Required-Response TypeServerResponseExample Usagesuites=[SuiteCode.HEARTS,SuiteCode.SPADES,SuiteCode.CLUBS]result=form_params_controller.send_integer_enum_array(suites)send_string_enum_arraydefsend_string_enum_array(self,days)ParametersParameterTypeTagsDescriptiondaysList of DaysForm, Required-Response TypeServerResponseExample Usagedays=[Days.SUNDAY,Days.MONDAY,Days.TUESDAY]result=form_params_controller.send_string_enum_array(days)send_string_in_form_with_new_linedefsend_string_in_form_with_new_line(self,body)ParametersParameterTypeTagsDescriptionbodyTestNstringEncodingForm, Required-Response TypeServerResponseExample Usagebody=TestNstringEncoding()()body.field='field0'body.name='name6'result=form_params_controller.send_string_in_form_with_new_line(body)send_string_in_form_with_rdefsend_string_in_form_with_r(self,body)ParametersParameterTypeTagsDescriptionbodyTestRstringEncodingForm, Required-Response TypeServerResponseExample Usagebody=TestRstringEncoding()()body.field='field0'body.name='name6'result=form_params_controller.send_string_in_form_with_r(body)send_string_in_form_with_r_ndefsend_string_in_form_with_r_n(self,body)ParametersParameterTypeTagsDescriptionbodyTestRNstringEncodingForm, Required-Response TypeServerResponseExample Usagebody=TestRNstringEncoding()()body.field='field0'body.name='name6'result=form_params_controller.send_string_in_form_with_r_n(body)send_optional_unix_date_time_in_bodydefsend_optional_unix_date_time_in_body(self,date_time=None)ParametersParameterTypeTagsDescriptiondate_timedatetimeForm, Optional-Response TypeServerResponseExample Usagedate_time=dt.datetime.utcfromtimestamp(1484719381)result=form_params_controller.send_optional_unix_date_time_in_body(date_time)send_optional_rfc_1123_in_bodydefsend_optional_rfc_1123_in_body(self,body)ParametersParameterTypeTagsDescriptionbodydatetimeForm, Required-Response TypeServerResponseExample Usagebody=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimeresult=form_params_controller.send_optional_rfc_1123_in_body(body)send_datetime_optional_in_endpointdefsend_datetime_optional_in_endpoint(self,body=None)ParametersParameterTypeTagsDescriptionbodydatetimeForm, Optional-Response TypeServerResponseExample Usageresult=form_params_controller.send_datetime_optional_in_endpoint()send_optional_unix_time_stamp_in_model_bodydefsend_optional_unix_time_stamp_in_model_body(self,date_time)ParametersParameterTypeTagsDescriptiondate_timeUnixDateTimeForm, Required-Response TypeServerResponseExample Usagedate_time=UnixDateTime()()date_time.date_time=dt.datetime.utcfromtimestamp(1484719381)result=form_params_controller.send_optional_unix_time_stamp_in_model_body(date_time)send_optional_unix_time_stamp_in_nested_model_bodydefsend_optional_unix_time_stamp_in_nested_model_body(self,date_time)ParametersParameterTypeTagsDescriptiondate_timeSendUnixDateTimeForm, Required-Response TypeServerResponseExample Usagedate_time=SendUnixDateTime()()date_time.date_time=UnixDateTime()()date_time.date_time.date_time=dt.datetime.utcfromtimestamp(1484719381)result=form_params_controller.send_optional_unix_time_stamp_in_nested_model_body(date_time)send_rfc_1123_date_time_in_nested_modeldefsend_rfc_1123_date_time_in_nested_model(self,body)ParametersParameterTypeTagsDescriptionbodySendRfc1123DateTimeForm, Required-Response TypeServerResponseExample Usagebody=SendRfc1123DateTime()()body.date_time=ModelWithOptionalRfc1123DateTime()()body.date_time.date_time=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimeresult=form_params_controller.send_rfc_1123_date_time_in_nested_model(body)send_rfc_1123_date_time_in_modeldefsend_rfc_1123_date_time_in_model(self,date_time)ParametersParameterTypeTagsDescriptiondate_timeModelWithOptionalRfc1123DateTimeForm, Required-Response TypeServerResponseExample Usagedate_time=ModelWithOptionalRfc1123DateTime()()date_time.date_time=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimeresult=form_params_controller.send_rfc_1123_date_time_in_model(date_time)send_optional_datetime_in_modeldefsend_optional_datetime_in_model(self,body)ParametersParameterTypeTagsDescriptionbodyModelWithOptionalRfc3339DateTimeForm, Required-Response TypeServerResponseExample Usagebody=ModelWithOptionalRfc3339DateTime()()body.date_time=dateutil.parser.parse('1994-02-13T14:01:54.9571247Z')result=form_params_controller.send_optional_datetime_in_model(body)send_rfc_339_date_time_in_nested_modelsdefsend_rfc_339_date_time_in_nested_models(self,body)ParametersParameterTypeTagsDescriptionbodySendRfc339DateTimeForm, Required-Response TypeServerResponseExample Usagebody=SendRfc339DateTime()()body.date_time=ModelWithOptionalRfc3339DateTime()()body.date_time.date_time=dateutil.parser.parse('1994-02-13T14:01:54.9571247Z')result=form_params_controller.send_rfc_339_date_time_in_nested_models(body)uuid_as_optionaldefuuid_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyUuidAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=UuidAsOptional()()body.uuid='123e4567-e89b-12d3-a456-426655440000'result=form_params_controller.uuid_as_optional(body)boolean_as_optionaldefboolean_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyBooleanAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=BooleanAsOptional()()body.boolean=Trueresult=form_params_controller.boolean_as_optional(body)date_as_optionaldefdate_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyDateAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=DateAsOptional()()body.date=dateutil.parser.parse('1994-02-13').date()result=form_params_controller.date_as_optional(body)dynamic_as_optionaldefdynamic_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyDynamicAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=DynamicAsOptional()()body.dynamic=jsonpickle.decode('{"dynamic":"test"}')result=form_params_controller.dynamic_as_optional(body)string_as_optionaldefstring_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyStringAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=StringAsOptional()()body.string='test'result=form_params_controller.string_as_optional(body)precision_as_optionaldefprecision_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyPrecisionAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=PrecisionAsOptional()()body.precision=1.23result=form_params_controller.precision_as_optional(body)long_as_optionaldeflong_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyLongAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=LongAsOptional()()body.long=123123result=form_params_controller.long_as_optional(body)send_number_as_optionaldefsend_number_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyNumberAsOptionalForm, Required-Response TypeServerResponseExample Usagebody=NumberAsOptional()()body.number=1result=form_params_controller.send_number_as_optional(body)BodyParamsControllerOverviewGet instanceAn instance of theBodyParamsControllerclass can be accessed from the API Client.body_params_controller = client.body_paramssend_delete_plain_textdefsend_delete_plain_text(self,text_string)ParametersParameterTypeTagsDescriptiontext_stringstringBody, Required-Response TypeServerResponseExample Usagetext_string='textString2'result=body_params_controller.send_delete_plain_text(text_string)send_delete_bodydefsend_delete_body(self,body)ParametersParameterTypeTagsDescriptionbodyDeleteBodyBody, Required-Response TypeServerResponseExample Usagebody=DeleteBody()()body.name='name6'body.field='field0'result=body_params_controller.send_delete_body(body)send_date_arraydefsend_date_array(self,dates)ParametersParameterTypeTagsDescriptiondatesList of dateBody, Required-Response TypeServerResponseExample Usagedates=[dateutil.parser.parse('2016-03-13').date(),dateutil.parser.parse('2016-03-13').date()]result=body_params_controller.send_date_array(dates)send_datedefsend_date(self,date)ParametersParameterTypeTagsDescriptiondatedateBody, Required-Response TypeServerResponseExample Usagedate=dateutil.parser.parse('2016-03-13').date()result=body_params_controller.send_date(date)send_unix_date_timedefsend_unix_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeBody, Required-Response TypeServerResponseExample Usagedatetime=dt.datetime.utcfromtimestamp(1480809600)result=body_params_controller.send_unix_date_time(datetime)send_rfc_1123_date_timedefsend_rfc_1123_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeBody, Required-Response TypeServerResponseExample Usagedatetime=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimeresult=body_params_controller.send_rfc_1123_date_time(datetime)send_rfc_3339_date_timedefsend_rfc_3339_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeBody, Required-Response TypeServerResponseExample Usagedatetime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')result=body_params_controller.send_rfc_3339_date_time(datetime)send_unix_date_time_arraydefsend_unix_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeBody, Required-Response TypeServerResponseExample Usagedatetimes=[dt.datetime.utcfromtimestamp(1480809600),dt.datetime.utcfromtimestamp(1480809600),dt.datetime.utcfromtimestamp(1480809600)]result=body_params_controller.send_unix_date_time_array(datetimes)send_rfc_1123_date_time_arraydefsend_rfc_1123_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeBody, Required-Response TypeServerResponseExample Usagedatetimes=[APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime,APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime,APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime]result=body_params_controller.send_rfc_1123_date_time_array(datetimes)send_rfc_3339_date_time_arraydefsend_rfc_3339_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeBody, Required-Response TypeServerResponseExample Usagedatetimes=[dateutil.parser.parse('2016-03-13T12:52:32.123Z'),dateutil.parser.parse('2016-03-13T12:52:32.123Z'),dateutil.parser.parse('2016-03-13T12:52:32.123Z')]result=body_params_controller.send_rfc_3339_date_time_array(datetimes)send_string_arraysends a string body paramdefsend_string_array(self,sarray)ParametersParameterTypeTagsDescriptionsarrayList of stringBody, Required-Response TypeServerResponseExample Usagesarray=['sarray8','sarray9']result=body_params_controller.send_string_array(sarray)update_stringdefupdate_string(self,value)ParametersParameterTypeTagsDescriptionvaluestringBody, Required-Response TypeServerResponseExample Usagevalue='value2'result=body_params_controller.update_string(value)send_integer_arraydefsend_integer_array(self,integers)ParametersParameterTypeTagsDescriptionintegersList of intBody, Required-Response TypeServerResponseExample Usageintegers=[45,46,47]result=body_params_controller.send_integer_array(integers)wrap_body_in_objectdefwrap_body_in_object(self,field,name)ParametersParameterTypeTagsDescriptionfieldstringBody, Required-namestringBody, Required-Response TypeServerResponseExample Usagefield='field6'name='name0'result=body_params_controller.wrap_body_in_object(field,name)additional_model_parametersdefadditional_model_parameters(self,model)ParametersParameterTypeTagsDescriptionmodelAdditionalModelParametersBody, Required-Response TypeServerResponseExample Usagemodel=AdditionalModelParameters()()model.name='name2'model.field='field4'model.address='address8'model.job=Job()()model.job.company='company8'result=body_params_controller.additional_model_parameters(model)validate_required_parameterdefvalidate_required_parameter(self,model,option=None)ParametersParameterTypeTagsDescriptionmodelValidateBody, Required-optionstringQuery, Optional-Response TypeServerResponseExample Usagemodel=Validate()()model.field='field4'model.name='name2'result=body_params_controller.validate_required_parameter(model)additional_model_parameters_1defadditional_model_parameters_1(self,model)ParametersParameterTypeTagsDescriptionmodelAdditionalModelParametersBody, Required-Response TypeServerResponseExample Usagemodel=AdditionalModelParameters()()model.name='name2'model.field='field4'model.address='address8'model.job=Job()()model.job.company='company8'result=body_params_controller.additional_model_parameters_1(model)send_modeldefsend_model(self,model)ParametersParameterTypeTagsDescriptionmodelEmployeeBody, Required-Response TypeServerResponseExample Usagemodel=Employee()()model.department='department8'model.dependents=[]model.dependents.append(Person())model.dependents[0].address='address5'model.dependents[0].age=237model.dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()model.dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.dependents[0].name='name9'model.dependents[0].uid='uid9'model.hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodel.joining_day=Days.TUESDAYmodel.salary=240model.working_days=[Days.THURSDAY,Days.WEDNESDAY_,Days.TUESDAY]model.address='address8'model.age=186model.birthday=dateutil.parser.parse('2016-03-13').date()model.birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.name='name2'model.uid='uid2'result=body_params_controller.send_model(model)send_model_arraydefsend_model_array(self,models)ParametersParameterTypeTagsDescriptionmodelsList of EmployeeBody, Required-Response TypeServerResponseExample Usagemodels=[]models.append(Employee())models[0].department='department6'models[0].dependents=[]models[0].dependents.append(Person())models[0].dependents[0].address='address9'models[0].dependents[0].age=49models[0].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[0].name='name3'models[0].dependents[0].uid='uid3'models[0].dependents.append(Person())models[0].dependents[1].address='address0'models[0].dependents[1].age=50models[0].dependents[1].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[1].name='name4'models[0].dependents[1].uid='uid4'models[0].dependents.append(Person())models[0].dependents[2].address='address1'models[0].dependents[2].age=51models[0].dependents[2].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[2].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[2].name='name5'models[0].dependents[2].uid='uid5'models[0].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[0].joining_day=Days.WEDNESDAY_models[0].salary=84models[0].working_days=[Days.SUNDAY]models[0].address='address2'models[0].age=254models[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].name='name6'models[0].uid='uid6'models.append(Employee())models[1].department='department7'models[1].dependents=[]models[1].dependents.append(Person())models[1].dependents[0].address='address0'models[1].dependents[0].age=50models[1].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[1].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].dependents[0].name='name4'models[1].dependents[0].uid='uid4'models[1].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[1].joining_day=Days.THURSDAYmodels[1].salary=85models[1].working_days=[Days.MONDAY,Days.TUESDAY]models[1].address='address3'models[1].age=255models[1].birthday=dateutil.parser.parse('2016-03-13').date()models[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].name='name7'models[1].uid='uid7'result=body_params_controller.send_model_array(models)send_dynamicdefsend_dynamic(self,dynamic)ParametersParameterTypeTagsDescriptiondynamicobjectBody, Required-Response TypeServerResponseExample Usagedynamic=jsonpickle.decode('{"key1":"val1","key2":"val2"}')result=body_params_controller.send_dynamic(dynamic)send_stringdefsend_string(self,value)ParametersParameterTypeTagsDescriptionvaluestringBody, Required-Response TypeServerResponseExample Usagevalue='value2'result=body_params_controller.send_string(value)send_string_enum_arraydefsend_string_enum_array(self,days)ParametersParameterTypeTagsDescriptiondaysList of DaysBody, Required-Response TypeServerResponseExample Usagedays=[Days.SUNDAY,Days.MONDAY,Days.TUESDAY]result=body_params_controller.send_string_enum_array(days)send_integer_enum_arraydefsend_integer_enum_array(self,suites)ParametersParameterTypeTagsDescriptionsuitesList of SuiteCodeBody, Required-Response TypeServerResponseExample Usagesuites=[SuiteCode.HEARTS,SuiteCode.SPADES,SuiteCode.CLUBS]result=body_params_controller.send_integer_enum_array(suites)update_modeldefupdate_model(self,model)ParametersParameterTypeTagsDescriptionmodelEmployeeBody, Required-Response TypeServerResponseExample Usagemodel=Employee()()model.department='department8'model.dependents=[]model.dependents.append(Person())model.dependents[0].address='address5'model.dependents[0].age=237model.dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()model.dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.dependents[0].name='name9'model.dependents[0].uid='uid9'model.hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodel.joining_day=Days.TUESDAYmodel.salary=240model.working_days=[Days.THURSDAY,Days.WEDNESDAY_,Days.TUESDAY]model.address='address8'model.age=186model.birthday=dateutil.parser.parse('2016-03-13').date()model.birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.name='name2'model.uid='uid2'result=body_params_controller.update_model(model)send_delete_body_with_modeldefsend_delete_body_with_model(self,model)ParametersParameterTypeTagsDescriptionmodelEmployeeBody, Required-Response TypeServerResponseExample Usagemodel=Employee()()model.department='department8'model.dependents=[]model.dependents.append(Person())model.dependents[0].address='address5'model.dependents[0].age=237model.dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()model.dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.dependents[0].name='name9'model.dependents[0].uid='uid9'model.hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodel.joining_day=Days.TUESDAYmodel.salary=240model.working_days=[Days.THURSDAY,Days.WEDNESDAY_,Days.TUESDAY]model.address='address8'model.age=186model.birthday=dateutil.parser.parse('2016-03-13').date()model.birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')model.name='name2'model.uid='uid2'result=body_params_controller.send_delete_body_with_model(model)send_delete_body_with_model_arraydefsend_delete_body_with_model_array(self,models)ParametersParameterTypeTagsDescriptionmodelsList of EmployeeBody, Required-Response TypeServerResponseExample Usagemodels=[]models.append(Employee())models[0].department='department6'models[0].dependents=[]models[0].dependents.append(Person())models[0].dependents[0].address='address9'models[0].dependents[0].age=49models[0].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[0].name='name3'models[0].dependents[0].uid='uid3'models[0].dependents.append(Person())models[0].dependents[1].address='address0'models[0].dependents[1].age=50models[0].dependents[1].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[1].name='name4'models[0].dependents[1].uid='uid4'models[0].dependents.append(Person())models[0].dependents[2].address='address1'models[0].dependents[2].age=51models[0].dependents[2].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[2].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[2].name='name5'models[0].dependents[2].uid='uid5'models[0].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[0].joining_day=Days.WEDNESDAY_models[0].salary=84models[0].working_days=[Days.SUNDAY]models[0].address='address2'models[0].age=254models[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].name='name6'models[0].uid='uid6'models.append(Employee())models[1].department='department7'models[1].dependents=[]models[1].dependents.append(Person())models[1].dependents[0].address='address0'models[1].dependents[0].age=50models[1].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[1].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].dependents[0].name='name4'models[1].dependents[0].uid='uid4'models[1].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[1].joining_day=Days.THURSDAYmodels[1].salary=85models[1].working_days=[Days.MONDAY,Days.TUESDAY]models[1].address='address3'models[1].age=255models[1].birthday=dateutil.parser.parse('2016-03-13').date()models[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].name='name7'models[1].uid='uid7'result=body_params_controller.send_delete_body_with_model_array(models)update_model_arraydefupdate_model_array(self,models)ParametersParameterTypeTagsDescriptionmodelsList of EmployeeBody, Required-Response TypeServerResponseExample Usagemodels=[]models.append(Employee())models[0].department='department6'models[0].dependents=[]models[0].dependents.append(Person())models[0].dependents[0].address='address9'models[0].dependents[0].age=49models[0].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[0].name='name3'models[0].dependents[0].uid='uid3'models[0].dependents.append(Person())models[0].dependents[1].address='address0'models[0].dependents[1].age=50models[0].dependents[1].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[1].name='name4'models[0].dependents[1].uid='uid4'models[0].dependents.append(Person())models[0].dependents[2].address='address1'models[0].dependents[2].age=51models[0].dependents[2].birthday=dateutil.parser.parse('2016-03-13').date()models[0].dependents[2].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].dependents[2].name='name5'models[0].dependents[2].uid='uid5'models[0].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[0].joining_day=Days.WEDNESDAY_models[0].salary=84models[0].working_days=[Days.SUNDAY]models[0].address='address2'models[0].age=254models[0].birthday=dateutil.parser.parse('2016-03-13').date()models[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[0].name='name6'models[0].uid='uid6'models.append(Employee())models[1].department='department7'models[1].dependents=[]models[1].dependents.append(Person())models[1].dependents[0].address='address0'models[1].dependents[0].age=50models[1].dependents[0].birthday=dateutil.parser.parse('2016-03-13').date()models[1].dependents[0].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].dependents[0].name='name4'models[1].dependents[0].uid='uid4'models[1].hired_at=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimemodels[1].joining_day=Days.THURSDAYmodels[1].salary=85models[1].working_days=[Days.MONDAY,Days.TUESDAY]models[1].address='address3'models[1].age=255models[1].birthday=dateutil.parser.parse('2016-03-13').date()models[1].birthtime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')models[1].name='name7'models[1].uid='uid7'result=body_params_controller.update_model_array(models)update_string_1defupdate_string_1(self,value)ParametersParameterTypeTagsDescriptionvaluestringBody, Required-Response TypeServerResponseExample Usagevalue='value2'result=body_params_controller.update_string_1(value)update_string_arraydefupdate_string_array(self,strings)ParametersParameterTypeTagsDescriptionstringsList of stringBody, Required-Response TypeServerResponseExample Usagestrings=['strings5']result=body_params_controller.update_string_array(strings)send_string_with_new_linedefsend_string_with_new_line(self,body)ParametersParameterTypeTagsDescriptionbodyTestNstringEncodingBody, Required-Response TypeServerResponseExample Usagebody=TestNstringEncoding()()body.field='field0'body.name='name6'result=body_params_controller.send_string_with_new_line(body)send_string_with_rdefsend_string_with_r(self,body)ParametersParameterTypeTagsDescriptionbodyTestRstringEncodingBody, Required-Response TypeServerResponseExample Usagebody=TestRstringEncoding()()body.field='field0'body.name='name6'result=body_params_controller.send_string_with_r(body)send_string_in_body_with_r_ndefsend_string_in_body_with_r_n(self,body)ParametersParameterTypeTagsDescriptionbodyTestRNstringEncodingBody, Required-Response TypeServerResponseExample Usagebody=TestRNstringEncoding()()body.field='field0'body.name='name6'result=body_params_controller.send_string_in_body_with_r_n(body)send_optional_unix_date_time_in_bodydefsend_optional_unix_date_time_in_body(self,date_time=None)ParametersParameterTypeTagsDescriptiondate_timedatetimeBody, Optional-Response TypeServerResponseExample Usagedate_time=dt.datetime.utcfromtimestamp(1484719381)result=body_params_controller.send_optional_unix_date_time_in_body(date_time)send_optional_rfc_1123_in_bodydefsend_optional_rfc_1123_in_body(self,body)ParametersParameterTypeTagsDescriptionbodydatetimeBody, Required-Response TypeServerResponseExample Usagebody=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimeresult=body_params_controller.send_optional_rfc_1123_in_body(body)send_datetime_optional_in_endpointdefsend_datetime_optional_in_endpoint(self,body=None)ParametersParameterTypeTagsDescriptionbodydatetimeBody, Optional-Response TypeServerResponseExample Usageresult=body_params_controller.send_datetime_optional_in_endpoint()send_optional_unix_time_stamp_in_model_bodydefsend_optional_unix_time_stamp_in_model_body(self,date_time)ParametersParameterTypeTagsDescriptiondate_timeUnixDateTimeBody, Required-Response TypeServerResponseExample Usagedate_time=UnixDateTime()()date_time.date_time=dt.datetime.utcfromtimestamp(1484719381)result=body_params_controller.send_optional_unix_time_stamp_in_model_body(date_time)send_optional_unix_time_stamp_in_nested_model_bodydefsend_optional_unix_time_stamp_in_nested_model_body(self,date_time)ParametersParameterTypeTagsDescriptiondate_timeSendUnixDateTimeBody, Required-Response TypeServerResponseExample Usagedate_time=SendUnixDateTime()()date_time.date_time=UnixDateTime()()date_time.date_time.date_time=dt.datetime.utcfromtimestamp(1484719381)result=body_params_controller.send_optional_unix_time_stamp_in_nested_model_body(date_time)send_rfc_1123_date_time_in_nested_modeldefsend_rfc_1123_date_time_in_nested_model(self,body)ParametersParameterTypeTagsDescriptionbodySendRfc1123DateTimeBody, Required-Response TypeServerResponseExample Usagebody=SendRfc1123DateTime()()body.date_time=ModelWithOptionalRfc1123DateTime()()body.date_time.date_time=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimeresult=body_params_controller.send_rfc_1123_date_time_in_nested_model(body)send_rfc_1123_date_time_in_modeldefsend_rfc_1123_date_time_in_model(self,date_time)ParametersParameterTypeTagsDescriptiondate_timeModelWithOptionalRfc1123DateTimeBody, Required-Response TypeServerResponseExample Usagedate_time=ModelWithOptionalRfc1123DateTime()()date_time.date_time=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimeresult=body_params_controller.send_rfc_1123_date_time_in_model(date_time)send_optional_datetime_in_modeldefsend_optional_datetime_in_model(self,body)ParametersParameterTypeTagsDescriptionbodyModelWithOptionalRfc3339DateTimeBody, Required-Response TypeServerResponseExample Usagebody=ModelWithOptionalRfc3339DateTime()()body.date_time=dateutil.parser.parse('1994-02-13T14:01:54.9571247Z')result=body_params_controller.send_optional_datetime_in_model(body)send_rfc_339_date_time_in_nested_modelsdefsend_rfc_339_date_time_in_nested_models(self,body)ParametersParameterTypeTagsDescriptionbodySendRfc339DateTimeBody, Required-Response TypeServerResponseExample Usagebody=SendRfc339DateTime()()body.date_time=ModelWithOptionalRfc3339DateTime()()body.date_time.date_time=dateutil.parser.parse('1994-02-13T14:01:54.9571247Z')result=body_params_controller.send_rfc_339_date_time_in_nested_models(body)uuid_as_optionaldefuuid_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyUuidAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=UuidAsOptional()()body.uuid='123e4567-e89b-12d3-a456-426655440000'result=body_params_controller.uuid_as_optional(body)boolean_as_optionaldefboolean_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyBooleanAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=BooleanAsOptional()()body.boolean=Trueresult=body_params_controller.boolean_as_optional(body)date_as_optionaldefdate_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyDateAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=DateAsOptional()()body.date=dateutil.parser.parse('1994-02-13').date()result=body_params_controller.date_as_optional(body)dynamic_as_optionaldefdynamic_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyDynamicAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=DynamicAsOptional()()body.dynamic=jsonpickle.decode('{"dynamic":"test"}')result=body_params_controller.dynamic_as_optional(body)string_as_optionaldefstring_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyStringAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=StringAsOptional()()body.string='test'result=body_params_controller.string_as_optional(body)precision_as_optionaldefprecision_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyPrecisionAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=PrecisionAsOptional()()body.precision=1.23result=body_params_controller.precision_as_optional(body)long_as_optionaldeflong_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyLongAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=LongAsOptional()()body.long=123123result=body_params_controller.long_as_optional(body)send_number_as_optionaldefsend_number_as_optional(self,body)ParametersParameterTypeTagsDescriptionbodyNumberAsOptionalBody, Required-Response TypeServerResponseExample Usagebody=NumberAsOptional()()body.number=1result=body_params_controller.send_number_as_optional(body)ErrorCodesControllerOverviewGet instanceAn instance of theErrorCodesControllerclass can be accessed from the API Client.error_codes_controller = client.error_codescatch_412_global_errordefcatch_412_global_error(self)Response TypemixedExample Usageresult=error_codes_controller.catch_412_global_error()get_501defget_501(self)Response TypemixedExample Usageresult=error_codes_controller.get_501()ErrorsHTTP Status CodeError DescriptionException Class501error 501NestedModelExceptionget_400defget_400(self)Response TypemixedExample Usageresult=error_codes_controller.get_400()get_500defget_500(self)Response TypemixedExample Usageresult=error_codes_controller.get_500()get_401defget_401(self)Response TypemixedExample Usageresult=error_codes_controller.get_401()ErrorsHTTP Status CodeError DescriptionException Class401401 LocalLocalTestException421DefaultLocalTestException431DefaultLocalTestException432DefaultLocalTestException441DefaultLocalTestExceptionDefaultInvalid response.LocalTestExceptionreceive_exception_with_unixtimestamp_exceptiondefreceive_exception_with_unixtimestamp_exception(self)Response TypemixedExample Usageresult=error_codes_controller.receive_exception_with_unixtimestamp_exception()ErrorsHTTP Status CodeError DescriptionException Class444unixtimestamp exceptionUnixTimeStampExceptionreceive_exception_with_rfc_1123_datetimedefreceive_exception_with_rfc_1123_datetime(self)Response TypemixedExample Usageresult=error_codes_controller.receive_exception_with_rfc_1123_datetime()ErrorsHTTP Status CodeError DescriptionException Class444Rfc1123 ExceptionRfc1123Exceptionreceive_exception_with_rfc_3339_datetimedefreceive_exception_with_rfc_3339_datetime(self)Response TypemixedExample Usageresult=error_codes_controller.receive_exception_with_rfc_3339_datetime()ErrorsHTTP Status CodeError DescriptionException Class444DateTime ExceptionExceptionWithRfc3339DateTimeExceptionreceive_endpoint_level_exceptiondefreceive_endpoint_level_exception(self)Response TypeComplex5Example Usageresult=error_codes_controller.receive_endpoint_level_exception()ErrorsHTTP Status CodeError DescriptionException Class451caught endpoint exceptionCustomErrorResponseExceptionreceive_global_level_exceptiondefreceive_global_level_exception(self)Response TypeComplex5Example Usageresult=error_codes_controller.receive_global_level_exception()date_in_exceptiondefdate_in_exception(self)Response TypemixedExample Usageresult=error_codes_controller.date_in_exception()ErrorsHTTP Status CodeError DescriptionException Class444date in exceptionExceptionWithDateExceptionuuid_in_exceptiondefuuid_in_exception(self)Response TypemixedExample Usageresult=error_codes_controller.uuid_in_exception()ErrorsHTTP Status CodeError DescriptionException Class444uuid in exceptionExceptionWithUUIDExceptiondynamic_in_exceptiondefdynamic_in_exception(self)Response TypemixedExample Usageresult=error_codes_controller.dynamic_in_exception()ErrorsHTTP Status CodeError DescriptionException Class444dynamic in ExceptionExceptionWithDynamicExceptionprecision_in_exceptiondefprecision_in_exception(self)Response TypemixedExample Usageresult=error_codes_controller.precision_in_exception()ErrorsHTTP Status CodeError DescriptionException Class444precision in ExceptionExceptionWithPrecisionExceptionboolean_in_exceptiondefboolean_in_exception(self)Response TypemixedExample Usageresult=error_codes_controller.boolean_in_exception()ErrorsHTTP Status CodeError DescriptionException Class444Boolean in ExceptionExceptionWithBooleanExceptionlong_in_exceptiondeflong_in_exception(self)Response TypemixedExample Usageresult=error_codes_controller.long_in_exception()ErrorsHTTP Status CodeError DescriptionException Class444long in exceptionExceptionWithLongExceptionnumber_in_exceptiondefnumber_in_exception(self)Response TypemixedExample Usageresult=error_codes_controller.number_in_exception()ErrorsHTTP Status CodeError DescriptionException Class444number in exceptionExceptionWithNumberExceptionget_exception_with_stringdefget_exception_with_string(self)Response TypemixedExample Usageresult=error_codes_controller.get_exception_with_string()ErrorsHTTP Status CodeError DescriptionException Class444exception with stringExceptionWithStringExceptionQueryParamControllerOverviewGet instanceAn instance of theQueryParamControllerclass can be accessed from the API Client.query_param_controller = client.query_paramdate_arraydefdate_array(self,dates)ParametersParameterTypeTagsDescriptiondatesList of dateQuery, Required-Response TypeServerResponseExample Usagedates=[dateutil.parser.parse('2016-03-13').date(),dateutil.parser.parse('2016-03-13').date()]result=query_param_controller.date_array(dates)optional_dynamic_query_paramget optional dynamic query parameterdefoptional_dynamic_query_param(self,name,_optional_query_parameters=None)ParametersParameterTypeTagsDescriptionnamestringQuery, Required-_optional_query_parametersarrayOptionalPass additional query parameters.Response TypeServerResponseExample Usagename='name0'_optional_query_parameters={'key0':'additionalQueryParams2'}result=query_param_controller.optional_dynamic_query_param(name,_optional_query_parameters)datedefdate(self,date)ParametersParameterTypeTagsDescriptiondatedateQuery, Required-Response TypeServerResponseExample Usagedate=dateutil.parser.parse('2016-03-13').date()result=query_param_controller.date(date)unix_date_time_arraydefunix_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeQuery, Required-Response TypeServerResponseExample Usagedatetimes=[dt.datetime.utcfromtimestamp(1480809600),dt.datetime.utcfromtimestamp(1480809600),dt.datetime.utcfromtimestamp(1480809600)]result=query_param_controller.unix_date_time_array(datetimes)unix_date_timedefunix_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeQuery, Required-Response TypeServerResponseExample Usagedatetime=dt.datetime.utcfromtimestamp(1480809600)result=query_param_controller.unix_date_time(datetime)rfc_1123_date_timedefrfc_1123_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeQuery, Required-Response TypeServerResponseExample Usagedatetime=APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetimeresult=query_param_controller.rfc_1123_date_time(datetime)rfc_1123_date_time_arraydefrfc_1123_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeQuery, Required-Response TypeServerResponseExample Usagedatetimes=[APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime,APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime,APIHelper.HttpDateTime.from_value('Mon, 15 Jun 2009 20:45:30 GMT').datetime]result=query_param_controller.rfc_1123_date_time_array(datetimes)rfc_3339_date_time_arraydefrfc_3339_date_time_array(self,datetimes)ParametersParameterTypeTagsDescriptiondatetimesList of datetimeQuery, Required-Response TypeServerResponseExample Usagedatetimes=[dateutil.parser.parse('2016-03-13T12:52:32.123Z'),dateutil.parser.parse('2016-03-13T12:52:32.123Z'),dateutil.parser.parse('2016-03-13T12:52:32.123Z')]result=query_param_controller.rfc_3339_date_time_array(datetimes)rfc_3339_date_timedefrfc_3339_date_time(self,datetime)ParametersParameterTypeTagsDescriptiondatetimedatetimeQuery, Required-Response TypeServerResponseExample Usagedatetime=dateutil.parser.parse('2016-03-13T12:52:32.123Z')result=query_param_controller.rfc_3339_date_time(datetime)no_paramsdefno_params(self)Response TypeServerResponseExample Usageresult=query_param_controller.no_params()string_paramdefstring_param(self,string)ParametersParameterTypeTagsDescriptionstringstringQuery, Required-Response TypeServerResponseExample Usagestring='string4'result=query_param_controller.string_param(string)url_paramdefurl_param(self,url)ParametersParameterTypeTagsDescriptionurlstringQuery, Required-Response TypeServerResponseExample Usageurl='url4'result=query_param_controller.url_param(url)number_arraydefnumber_array(self,integers)ParametersParameterTypeTagsDescriptionintegersList of intQuery, Required-Response TypeServerResponseExample Usageintegers=[45,46,47]result=query_param_controller.number_array(integers)string_arraydefstring_array(self,strings)ParametersParameterTypeTagsDescriptionstringsList of stringQuery, Required-Response TypeServerResponseExample Usagestrings=['strings5']result=query_param_controller.string_array(strings)simple_querydefsimple_query(self,boolean,number,string,_optional_query_parameters=None)ParametersParameterTypeTagsDescriptionbooleanboolQuery, Required-numberintQuery, Required-stringstringQuery, Required-_optional_query_parametersarrayOptionalPass additional query parameters.Response TypeServerResponseExample Usageboolean=Falsenumber=158string='string4'_optional_query_parameters={'key0':'additionalQueryParams2'}result=query_param_controller.simple_query(boolean,number,string,_optional_query_parameters)string_enum_arraydefstring_enum_array(self,days)ParametersParameterTypeTagsDescriptiondaysList of DaysQuery, Required-Response TypeServerResponseExample Usagedays=[Days.SUNDAY,Days.MONDAY,Days.TUESDAY]result=query_param_controller.string_enum_array(days)multiple_paramsdefmultiple_params(self,number,precision,string,url)ParametersParameterTypeTagsDescriptionnumberintQuery, Required-precisionfloatQuery, Required-stringstringQuery, Required-urlstringQuery, Required-Response TypeServerResponseExample Usagenumber=158precision=112.04string='string4'url='url4'result=query_param_controller.multiple_params(number,precision,string,url)integer_enum_arraydefinteger_enum_array(self,suites)ParametersParameterTypeTagsDescriptionsuitesList of SuiteCodeQuery, Required-Response TypeServerResponseExample Usagesuites=[SuiteCode.HEARTS,SuiteCode.SPADES,SuiteCode.CLUBS]result=query_param_controller.integer_enum_array(suites)EchoControllerOverviewGet instanceAn instance of theEchoControllerclass can be accessed from the API Client.echo_controller = client.echojson_echoEcho's back the requestdefjson_echo(self,input)ParametersParameterTypeTagsDescriptioninputobjectBody, Required-Response TypemixedExample Usageinput=jsonpickle.decode('{"key1":"val1","key2":"val2"}')result=echo_controller.json_echo(input)form_echoSends the request including any form params as JSONdefform_echo(self,input)ParametersParameterTypeTagsDescriptioninputobjectForm, Required-Response TypemixedExample Usageinput=jsonpickle.decode('{"key1":"val1","key2":"val2"}')result=echo_controller.form_echo(input)query_echodefquery_echo(self,_optional_query_parameters=None)ParametersParameterTypeTagsDescription_optional_query_parametersarrayOptionalPass additional query parameters.Response TypeEchoResponseExample Usage_optional_query_parameters={'key0':'additionalQueryParams2'}result=echo_controller.query_echo(_optional_query_parameters)HeaderControllerOverviewGet instanceAn instance of theHeaderControllerclass can be accessed from the API Client.header_controller = client.headersend_headersSends a single header paramsdefsend_headers(self,custom_header,value)ParametersParameterTypeTagsDescriptioncustom_headerstringHeader, Required-valuestringForm, RequiredRepresents the value of the custom headerResponse TypeServerResponseExample Usagecustom_header='custom-header2'value='value2'result=header_controller.send_headers(custom_header,value)TemplateParamsControllerOverviewGet instanceAn instance of theTemplateParamsControllerclass can be accessed from the API Client.template_params_controller = client.template_paramssend_string_arraydefsend_string_array(self,strings)ParametersParameterTypeTagsDescriptionstringsList of stringTemplate, Required-Response TypeEchoResponseExample Usagestrings=['strings5']result=template_params_controller.send_string_array(strings)send_integer_arraydefsend_integer_array(self,integers)ParametersParameterTypeTagsDescriptionintegersList of intTemplate, Required-Response TypeEchoResponseExample Usageintegers=[45,46,47]result=template_params_controller.send_integer_array(integers)QueryParamsControllerOverviewGet instanceAn instance of theQueryParamsControllerclass can be accessed from the API Client.query_params_controller = client.query_paramssend_number_as_optionaldefsend_number_as_optional(self,number,number_1=None)ParametersParameterTypeTagsDescriptionnumberintQuery, Required-number_1intQuery, Optional-Response TypeServerResponseExample Usagenumber=1number_1=1result=query_params_controller.send_number_as_optional(number,number_1)send_long_as_optionaldefsend_long_as_optional(self,long,long_1=None)ParametersParameterTypeTagsDescriptionlong`longint`Query, Requiredlong_1`longint`Query, OptionalResponse TypeServerResponseExample Usagelong=123123long_1=123123result=query_params_controller.send_long_as_optional(long,long_1)precision_as_optionaldefprecision_as_optional(self,precision,precision_1=None)ParametersParameterTypeTagsDescriptionprecisionfloatQuery, Required-precision_1floatQuery, Optional-Response TypeServerResponseExample Usageprecision=1.23precision_1=1.23result=query_params_controller.precision_as_optional(precision,precision_1)boolean_as_optionaldefboolean_as_optional(self,boolean,boolean_1=None)ParametersParameterTypeTagsDescriptionbooleanboolQuery, Required-boolean_1boolQuery, Optional-Response TypeServerResponseExample Usageboolean=Trueboolean_1=Trueresult=query_params_controller.boolean_as_optional(boolean,boolean_1)rfc_1123_datetime_as_optionaldefrfc_1123_datetime_as_optional(self,date_time,date_time_1=None)ParametersParameterTypeTagsDescriptiondate_timedatetimeQuery, Required-date_time_1datetimeQuery, Optional-Response TypeServerResponseExample Usagedate_time=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimedate_time_1=APIHelper.HttpDateTime.from_value('Sun, 06 Nov 1994 08:49:37 GMT').datetimeresult=query_params_controller.rfc_1123_datetime_as_optional(date_time,date_time_1)rfc_3339_datetime_as_optionaldefrfc_3339_datetime_as_optional(self,date_time,date_time_1=None)ParametersParameterTypeTagsDescriptiondate_timedatetimeQuery, Required-date_time_1datetimeQuery, Optional-Response TypeServerResponseExample Usagedate_time=dateutil.parser.parse('1994-02-13 14:01:54')date_time_1=dateutil.parser.parse('1994-02-13 14:01:54')result=query_params_controller.rfc_3339_datetime_as_optional(date_time,date_time_1)send_date_as_optionaldefsend_date_as_optional(self,date,date_1=None)ParametersParameterTypeTagsDescriptiondatedateQuery, Required-date_1dateQuery, Optional-Response TypeServerResponseExample Usagedate=dateutil.parser.parse('1994-02-13').date()date_1=dateutil.parser.parse('1994-02-13').date()result=query_params_controller.send_date_as_optional(date,date_1)send_string_as_optionaldefsend_string_as_optional(self,string,string_1=None)ParametersParameterTypeTagsDescriptionstringstringQuery, Required-string_1stringQuery, Optional-Response TypeServerResponseExample Usagestring='test'string_1='test'result=query_params_controller.send_string_as_optional(string,string_1)unixdatetime_as_optionaldefunixdatetime_as_optional(self,date_time,date_time_1=None)ParametersParameterTypeTagsDescriptiondate_timedatetimeQuery, Required-date_time_1datetimeQuery, Optional-Response TypeServerResponseExample Usagedate_time=dt.datetime.utcfromtimestamp(1484719381)date_time_1=dt.datetime.utcfromtimestamp(1484719381)result=query_params_controller.unixdatetime_as_optional(date_time,date_time_1)Model ReferenceStructuresEmployeeBossDeleteBodyEchoResponsePersonServerResponseQueryParameterJobAdditionalModelParametersValidateTestNstringEncodingTestRstringEncodingTestRNstringEncodingSendRfc1123DateTimeModelWithOptionalRfc1123DateTimeSendRfc339DateTimeUuidAsOptionalDynamicAsOptionalModelWithOptionalRfc3339DateTimeUnixDateTimeSendUnixDateTimePrecisionAsOptionalStringAsOptionalLongAsOptionalNumberAsOptionalBooleanAsOptionalSoftwareTesterDeveloperGlossEntryMineralDiureticBossCompanyBetaBlockerAnticoagulantEmployeeCompCompanyAttributesResponseWithEnumGlossDefGlossListGlossDivGlossaryImagingLabAntianginalAceInhibitorMedicationComplex1Complex2AdvancedDataToSignContactDetailsStylingDialogsSignatureTypeRedirectSettingsTimeToLiveStatusBeforeUiComplex3SignerComplex5ResponseDataFeedEntryDateAsOptionalAddPrecisionInExceptionAddUuidInGlobalExceptionAddRfc1123DatetimeInGlobalExceptionAddNumberInExceptionAddDynamicInExceptionAddRfc3339DatetimeInGlobalExceptionAddBooleanInGlobalExceptionAddDateInGlobalExceptionAddStringInGlobalExceptionAddUnixTimeStampInGlobalExceptionAddLongInGlobalExceptionEmployeeClass NameEmployeeInherits FromPersonFieldsNameTypeTagsDescriptiondepartmentstring-dependentsList of Person-hired_atdatetime-joining_dayDaysDefault:'Monday'salaryint-working_daysList of Days-bossPersonOptional-Example (as JSON){"department":"department0","dependents":[{"address":"address3","age":45,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name7","uid":"uid7","personType":null},{"address":"address4","age":46,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name8","uid":"uid8","personType":null},{"address":"address5","age":47,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name9","uid":"uid9","personType":null}],"hiredAt":"Mon, 15 Jun 2009 20:45:30 GMT","joiningDay":"Sunday","salary":176,"workingDays":["Monday"],"boss":null,"address":"address6","age":250,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name0","uid":"uid0","personType":null}BossTesting circular reference.Class NameBossInherits FromEmployeeFieldsNameTypeTagsDescriptionpromoted_atdatetime-assistantEmployeeOptional-Example (as JSON){"promotedAt":1480809600,"assistant":null,"department":"department0","dependents":[{"address":"address3","age":45,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name7","uid":"uid7","personType":null},{"address":"address4","age":46,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name8","uid":"uid8","personType":null},{"address":"address5","age":47,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name9","uid":"uid9","personType":null}],"hiredAt":"Mon, 15 Jun 2009 20:45:30 GMT","joiningDay":"Sunday","salary":176,"workingDays":["Monday"],"boss":null,"address":"address6","age":250,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name0","uid":"uid0","personType":null}DeleteBodyClass NameDeleteBodyFieldsNameTypeDescriptionnamestring-fieldstring-Example (as JSON){"name":"name0","field":"field6"}EchoResponseRaw http Request infoClass NameEchoResponseFieldsNameTypeTagsDescriptionbodydictOptional-headersdictOptional-methodstringOptional-pathstringOptionalrelativePathquerydictOptional-upload_countintOptional-Example (as JSON){"body":null,"headers":null,"method":null,"path":null,"query":null,"uploadCount":null}PersonClass NamePersonFieldsNameTypeTagsDescriptionaddressstring-age`longint`birthdaydate-birthtimedatetime-namestring-uidstring-person_typestringOptional-Example (as JSON){"address":"address6","age":250,"birthday":"2016-03-13","birthtime":"2016-03-13T12:52:32.123Z","name":"name0","uid":"uid0","personType":null}ServerResponseClass NameServerResponseFieldsNameTypeTagsDescriptionpassedbool-messagestringOptional-inputdictOptional-Example (as JSON){"passed":false,"Message":null,"input":null}QueryParameterQuery parameter key value pair echoed back from the server.Class NameQueryParameterFieldsNameTypeTagsDescriptionkeystringOptional-Example (as JSON){"key":null}JobClass NameJobFieldsNameTypeDescriptioncompanystring-Example (as JSON){"company":"company0"}AdditionalModelParametersClass NameAdditionalModelParametersFieldsNameTypeDescriptionnamestring-fieldstring-addressstring-jobJob-Example (as JSON){"name":"name0","field":"field6","address":"address6","Job":{"company":"company6"}}ValidateClass NameValidateFieldsNameTypeTagsDescriptionfieldstring-namestring-addressstringOptional-Example (as JSON){"field":"field6","name":"name0","address":null}TestNstringEncodingClass NameTestNstringEncodingFieldsNameTypeDescriptionfieldstring-namestring-Example (as JSON){"field":"field6","name":"name0"}TestRstringEncodingClass NameTestRstringEncodingFieldsNameTypeDescriptionfieldstring-namestring-Example (as JSON){"field":"field6","name":"name0"}TestRNstringEncodingClass NameTestRNstringEncodingFieldsNameTypeDescriptionfieldstring-namestring-Example (as JSON){"field":"field6","name":"name0"}SendRfc1123DateTimeClass NameSendRfc1123DateTimeFieldsNameTypeTagsDescriptiondate_timeModelWithOptionalRfc1123DateTimeOptional-Example (as JSON){"dateTime":null}ModelWithOptionalRfc1123DateTimeClass NameModelWithOptionalRfc1123DateTimeFieldsNameTypeTagsDescriptiondate_timedatetimeOptional-Example (as JSON){"dateTime":null}SendRfc339DateTimeClass NameSendRfc339DateTimeFieldsNameTypeTagsDescriptiondate_timeModelWithOptionalRfc3339DateTimeOptional-Example (as JSON){"dateTime":{"dateTime":"1994-02-13T14:01:54.9571247Z"}}UuidAsOptionalClass NameUuidAsOptionalFieldsNameTypeTagsDescriptionuuid`uuidstring`OptionalExample (as JSON){"uuid":null}DynamicAsOptionalClass NameDynamicAsOptionalFieldsNameTypeTagsDescriptiondynamicobjectOptional-Example (as JSON){"dynamic":null}ModelWithOptionalRfc3339DateTimeClass NameModelWithOptionalRfc3339DateTimeFieldsNameTypeTagsDescriptiondate_timedatetimeOptional-Example (as JSON){"dateTime":null}UnixDateTimeClass NameUnixDateTimeFieldsNameTypeTagsDescriptiondate_timedatetimeOptional-Example (as JSON){"dateTime":null}SendUnixDateTimeClass NameSendUnixDateTimeFieldsNameTypeTagsDescriptiondate_timeUnixDateTimeOptional-Example (as JSON){"dateTime":null}PrecisionAsOptionalClass NamePrecisionAsOptionalFieldsNameTypeTagsDescriptionprecisionfloatOptional-Example (as JSON){"precision":null}StringAsOptionalClass NameStringAsOptionalFieldsNameTypeTagsDescriptionstringstringOptional-Example (as JSON){"string":null}LongAsOptionalClass NameLongAsOptionalFieldsNameTypeTagsDescriptionlong`longint`OptionalExample (as JSON){"long":null}NumberAsOptionalClass NameNumberAsOptionalFieldsNameTypeTagsDescriptionnumberintOptional-Example (as JSON){"number":null}BooleanAsOptionalClass NameBooleanAsOptionalFieldsNameTypeTagsDescriptionbooleanboolOptional-Example (as JSON){"boolean":null}SoftwareTesterClass NameSoftwareTesterInherits FromEmployeeCompFieldsNameTypeDescriptionteamstring-designationstring-rolestring-Example (as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Muhammad","last name":"Farhan","id":"123456","team":"Testing","designation":"Tester","role":"Testing"}DeveloperClass NameDeveloperInherits FromEmployeeCompFieldsNameTypeDescriptionteamstring-designationstring-rolestring-Example (as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Muhammad","last name":"Farhan","id":"123456","team":"CORE","designation":"Manager","role":"Team Lead"}GlossEntryClass NameGlossEntryFieldsNameTypeDescriptionidstring-sort_asstring-gloss_termstring-acronymstring-abbrevstring-gloss_defGlossDef-gloss_seestring-Example (as JSON){"ID":"SGML","SortAs":"SGML","GlossTerm":"Standard Generalized Markup Language","Acronym":"SGML","Abbrev":"ISO 8879:1986","GlossDef":{"para":"A meta-markup language, used to create markup languages such as DocBook.","GlossSeeAlso":["GML","XML"]},"GlossSee":"markup"}MineralClass NameMineralFieldsNameTypeDescriptionnamestring-strengthstring-dosestring-routestring-sigstring-pill_countstring-refillsstring-Example (as JSON){"name":"potassium chloride ER","strength":"10 mEq Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}DiureticClass NameDiureticFieldsNameTypeDescriptionnamestring-strengthstring-dosestring-routestring-sigstring-pill_countstring-refillsstring-Example (as JSON){"name":"furosemide","strength":"40 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}BossCompanyClass NameBossCompanyInherits FromCompanyFieldsNameTypeDescriptionfirst_namestring-last_namestring-address_bossstring-Example (as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Adeel","last name":"Ali","address_boss":"nust"}BetaBlockerClass NameBetaBlockerFieldsNameTypeDescriptionnamestring-strengthstring-dosestring-routestring-sigstring-pill_countstring-refillsstring-Example (as JSON){"name":"metoprolol tartrate","strength":"25 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}AnticoagulantClass NameAnticoagulantFieldsNameTypeDescriptionnamestring-strengthstring-dosestring-routestring-sigstring-pill_countstring-refillsstring-Example (as JSON){"name":"warfarin sodium","strength":"3 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}EmployeeCompClass NameEmployeeCompInherits FromCompanyFieldsNameTypeDescriptionfirst_namestring-last_namestring-idstring-Example (as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601","first name":"Muhammad","last name":"Farhan","id":"123456"}CompanyClass NameCompanyFieldsNameTypeTagsDescriptioncompany_namestring-addressstring-cell_numberstring-companystringOptional-Example (as JSON){"company name":"APIMatic","address":"nust","cell number":"090078601"}AttributesClass NameAttributesFieldsNameTypeDescriptionexclusive_maximumbool-exclusive_minimumbool-idstring-Example (as JSON){"exclusiveMaximum":false,"exclusiveMinimum":false,"id":"5a9fcb01caacc310dc6bab51"}ResponseWithEnumClass NameResponseWithEnumFieldsNameTypeDescriptionparam_formatParamFormat-optionalbool-mtypeType-constantbool-is_arraybool-is_streambool-is_attributebool-is_mapbool-attributesAttributes-nullablebool-idstring-namestring-descriptionstring-Example (as JSON){"paramFormat":"Template","optional":false,"type":"Long","constant":false,"isArray":false,"isStream":false,"isAttribute":false,"isMap":false,"attributes":{"exclusiveMaximum":false,"exclusiveMinimum":false,"id":"5a9fcb01caacc310dc6bab51"},"nullable":false,"id":"5a9fcb01caacc310dc6bab50","name":"petId","description":"ID of pet to update"}GlossDefClass NameGlossDefFieldsNameTypeDescriptionparastring-gloss_see_alsoList of string-Example (as JSON){"para":"A meta-markup language, used to create markup languages such as DocBook.","GlossSeeAlso":["GML","XML"]}GlossListClass NameGlossListFieldsNameTypeDescriptiongloss_entryGlossEntry-Example (as JSON){"GlossEntry":{"ID":"SGML","SortAs":"SGML","GlossTerm":"Standard Generalized Markup Language","Acronym":"SGML","Abbrev":"ISO 8879:1986","GlossDef":{"para":"A meta-markup language, used to create markup languages such as DocBook.","GlossSeeAlso":["GML","XML"]},"GlossSee":"markup"}}GlossDivClass NameGlossDivFieldsNameTypeDescriptiontitlestring-gloss_listGlossList-Example (as JSON){"title":"S","GlossList":{"GlossEntry":{"ID":"SGML","SortAs":"SGML","GlossTerm":"Standard Generalized Markup Language","Acronym":"SGML","Abbrev":"ISO 8879:1986","GlossDef":{"para":"A meta-markup language, used to create markup languages such as DocBook.","GlossSeeAlso":["GML","XML"]},"GlossSee":"markup"}}}GlossaryClass NameGlossaryFieldsNameTypeDescriptiontitlestring-gloss_divGlossDiv-Example (as JSON){"title":"example glossary","GlossDiv":{"title":"S","GlossList":{"GlossEntry":{"ID":"SGML","SortAs":"SGML","GlossTerm":"Standard Generalized Markup Language","Acronym":"SGML","Abbrev":"ISO 8879:1986","GlossDef":{"para":"A meta-markup language, used to create markup languages such as DocBook.","GlossSeeAlso":["GML","XML"]},"GlossSee":"markup"}}}}ImagingClass NameImagingFieldsNameTypeDescriptionnamestring-timestring-locationstring-Example (as JSON){"name":"Chest X-Ray","time":"Today","location":"Main Hospital Radiology"}LabClass NameLabFieldsNameTypeDescriptionnamestring-timestring-locationstring-Example (as JSON){"name":"Arterial Blood Gas","time":"Today","location":"Main Hospital Lab"}AntianginalClass NameAntianginalFieldsNameTypeDescriptionnamestring-strengthstring-dosestring-routestring-sigstring-pill_countstring-refillsstring-Example (as JSON){"name":"nitroglycerin","strength":"0.4 mg Sublingual Tab","dose":"1 tab","route":"SL","sig":"q15min PRN","pillCount":"#30","refills":"Refill 1"}AceInhibitorClass NameAceInhibitorFieldsNameTypeDescriptionnamestring-strengthstring-dosestring-routestring-sigstring-pill_countstring-refillsstring-Example (as JSON){"name":"lisinopril","strength":"10 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}MedicationClass NameMedicationFieldsNameTypeDescriptionace_inhibitorsList of AceInhibitor-antianginalList of Antianginal-anticoagulantsList of Anticoagulant-beta_blockerList of BetaBlocker-diureticList of Diuretic-mineralList of Mineral-Example (as JSON){"aceInhibitors":[{"name":"lisinopril","strength":"10 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"antianginal":[{"name":"nitroglycerin","strength":"0.4 mg Sublingual Tab","dose":"1 tab","route":"SL","sig":"q15min PRN","pillCount":"#30","refills":"Refill 1"}],"anticoagulants":[{"name":"warfarin sodium","strength":"3 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"betaBlocker":[{"name":"metoprolol tartrate","strength":"25 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"diuretic":[{"name":"furosemide","strength":"40 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"mineral":[{"name":"potassium chloride ER","strength":"10 mEq Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}]}Complex1Class NameComplex1FieldsNameTypeDescriptionmedicationsList of Medication-labsList of Lab-imagingList of Imaging-Example (as JSON){"medications":[{"aceInhibitors":[{"name":"lisinopril","strength":"10 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"antianginal":[{"name":"nitroglycerin","strength":"0.4 mg Sublingual Tab","dose":"1 tab","route":"SL","sig":"q15min PRN","pillCount":"#30","refills":"Refill 1"}],"anticoagulants":[{"name":"warfarin sodium","strength":"3 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"betaBlocker":[{"name":"metoprolol tartrate","strength":"25 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"diuretic":[{"name":"furosemide","strength":"40 mg Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}],"mineral":[{"name":"potassium chloride ER","strength":"10 mEq Tab","dose":"1 tab","route":"PO","sig":"daily","pillCount":"#90","refills":"Refill 3"}]}],"labs":[{"name":"Arterial Blood Gas","time":"Today","location":"Main Hospital Lab"},{"name":"BMP","time":"Today","location":"Primary Care Clinic"},{"name":"BNP","time":"3 Weeks","location":"Primary Care Clinic"},{"name":"BUN","time":"1 Year","location":"Primary Care Clinic"},{"name":"Cardiac Enzymes","time":"Today","location":"Primary Care Clinic"},{"name":"CBC","time":"1 Year","location":"Primary Care Clinic"},{"name":"Creatinine","time":"1 Year","location":"Main Hospital Lab"},{"name":"Electrolyte Panel","time":"1 Year","location":"Primary Care Clinic"},{"name":"Glucose","time":"1 Year","location":"Main Hospital Lab"},{"name":"PT/INR","time":"3 Weeks","location":"Primary Care Clinic"},{"name":"PTT","time":"3 Weeks","location":"Coumadin Clinic"},{"name":"TSH","time":"1 Year","location":"Primary Care Clinic"}],"imaging":[{"name":"Chest X-Ray","time":"Today","location":"Main Hospital Radiology"},{"name":"Chest X-Ray","time":"Today","location":"Main Hospital Radiology"},{"name":"Chest X-Ray","time":"Today","location":"Main Hospital Radiology"}]}Complex2Class NameComplex2FieldsNameTypeDescriptionglossaryGlossary-Example (as JSON){"glossary":{"title":"example glossary","GlossDiv":{"title":"S","GlossList":{"GlossEntry":{"ID":"SGML","SortAs":"SGML","GlossTerm":"Standard Generalized Markup Language","Acronym":"SGML","Abbrev":"ISO 8879:1986","GlossDef":{"para":"A meta-markup language, used to create markup languages such as DocBook.","GlossSeeAlso":["GML","XML"]},"GlossSee":"markup"}}}}}AdvancedClass NameAdvancedFieldsNameTypeDescriptiontagsList of string-attachmentsint-required_signaturesint-get_social_security_numberbool-time_to_liveTimeToLive-Example (as JSON){"tags":["develop","fun_with_documents"],"attachments":0,"requiredSignatures":0,"getSocialSecurityNumber":false,"timeToLive":{"deadline":"2018-06-29T14:57:25Z","deleteAfterHours":1}}DataToSignClass NameDataToSignFieldsNameTypeDescriptionfile_namestring-convert_to_pdfbool-Example (as JSON){"fileName":"sample.txt","convertToPDF":false}ContactDetailsClass NameContactDetailsFieldsNameTypeDescriptionemailstring-urlstring-Example (as JSON){"email":"test@test.com","url":"https://idfy.io"}StylingClass NameStylingFieldsNameTypeDescriptioncolor_themestring-spinnerstring-Example (as JSON){"colorTheme":"Pink","spinner":"Cubes"}DialogsClass NameDialogsFieldsNameTypeDescriptionbeforeBefore-Example (as JSON){"before":{"useCheckBox":false,"title":"Info","message":"Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."}}SignatureTypeClass NameSignatureTypeFieldsNameTypeDescriptionmechanismstring-on_eaccept_use_hand_written_signaturebool-Example (as JSON){"mechanism":"pkisignature","onEacceptUseHandWrittenSignature":false}RedirectSettingsClass NameRedirectSettingsFieldsNameTypeDescriptionredirect_modestring-Example (as JSON){"redirectMode":"donot_redirect"}TimeToLiveClass NameTimeToLiveFieldsNameTypeDescriptiondeadlinestring-delete_after_hoursint-Example (as JSON){"deadline":"2018-06-29T14:57:25Z","deleteAfterHours":1}StatusClass NameStatusFieldsNameTypeDescriptiondocument_statusstring-completed_packagesList of string-attachment_packagesobject-Example (as JSON){"documentStatus":"unsigned","completedPackages":[],"attachmentPackages":{}}BeforeClass NameBeforeFieldsNameTypeDescriptionuse_check_boxbool-titlestring-messagestring-Example (as JSON){"useCheckBox":false,"title":"Info","message":"Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."}UiClass NameUiFieldsNameTypeDescriptiondialogsDialogs-languageLanguageEnum-stylingStyling-Example (as JSON){"dialogs":{"before":{"useCheckBox":false,"title":"Info","message":"Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."}},"language":"EN","styling":{"colorTheme":"Pink","spinner":"Cubes"}}Complex3Class NameComplex3FieldsNameTypeDescriptiondocument_idstring-signersList of Signer-statusStatus-titlestring-descriptionstring-external_idstring-data_to_signDataToSign-contact_detailsContactDetails-advancedAdvanced-Example (as JSON){"documentId":"099cceda-38a8-4b01-87b9-a8f2007675d6","signers":[{"id":"1bef97d1-0704-4eb2-a490-a8f2007675db","url":"https://sign-test.idfy.io/start?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzM4NCJ9.eyJrdmVyc2lvbiI6IjdmNzhjNzNkMmQ1MjQzZWRiYjdiNDI0MmI2MDE1MWU4IiwiZG9jaWQiOiIwOTljY2VkYS0zOGE4LTRiMDEtODdiOS1hOGYyMDA3Njc1ZDYiLCJhaWQiOiJjMGNlMTQ2OC1hYzk0LTRiMzQtODc2ZS1hODg1MDBjMmI5YTEiLCJsZyI6ImVuIiwiZXJyIjpudWxsLCJpZnIiOmZhbHNlLCJ3Ym1zZyI6ZmFsc2UsInNmaWQiOiIxYmVmOTdkMS0wNzA0LTRlYjItYTQ5MC1hOGYyMDA3Njc1ZGIiLCJ1cmxleHAiOm51bGwsImF0aCI6bnVsbCwiZHQiOiJUZXN0IGRvY3VtZW50IiwidmYiOmZhbHNlLCJhbiI6IklkZnkgU0RLIGRlbW8iLCJ0aCI6IlBpbmsiLCJzcCI6IkN1YmVzIiwiZG9tIjpudWxsLCJyZGlyIjpmYWxzZSwidXQiOiJ3ZWIiLCJ1dHYiOm51bGwsInNtIjoidGVzdEB0ZXN0LmNvbSJ9.Dyy2RSeR6dmU8qxOEi-2gEX3Gg7wry6JhkZIWOuADDdu5jJWidQLcxfJn_qAHNpb","links":[],"externalSignerId":"uoiahsd321982983jhrmnec2wsadm32","redirectSettings":{"redirectMode":"donot_redirect"},"signatureType":{"mechanism":"pkisignature","onEacceptUseHandWrittenSignature":false},"ui":{"dialogs":{"before":{"useCheckBox":false,"title":"Info","message":"Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."}},"language":"EN","styling":{"colorTheme":"Pink","spinner":"Cubes"}},"tags":[],"order":0,"required":false}],"status":{"documentStatus":"unsigned","completedPackages":[],"attachmentPackages":{}},"title":"Test document","description":"This is an important document","externalId":"ae7b9ca7-3839-4e0d-a070-9f14bffbbf55","dataToSign":{"fileName":"sample.txt","convertToPDF":false},"contactDetails":{"email":"test@test.com","url":"https://idfy.io"},"advanced":{"tags":["develop","fun_with_documents"],"attachments":0,"requiredSignatures":0,"getSocialSecurityNumber":false,"timeToLive":{"deadline":"2018-06-29T14:57:25Z","deleteAfterHours":1}}}SignerClass NameSignerFieldsNameTypeDescriptionidstring-urlstring-linksList of string-external_signer_idstring-redirect_settingsRedirectSettings-signature_typeSignatureType-uiUi-tagsList of string-orderint-requiredbool-Example (as JSON){"id":"1bef97d1-0704-4eb2-a490-a8f2007675db","url":"https://sign-test.idfy.io/start?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzM4NCJ9.eyJrdmVyc2lvbiI6IjdmNzhjNzNkMmQ1MjQzZWRiYjdiNDI0MmI2MDE1MWU4IiwiZG9jaWQiOiIwOTljY2VkYS0zOGE4LTRiMDEtODdiOS1hOGYyMDA3Njc1ZDYiLCJhaWQiOiJjMGNlMTQ2OC1hYzk0LTRiMzQtODc2ZS1hODg1MDBjMmI5YTEiLCJsZyI6ImVuIiwiZXJyIjpudWxsLCJpZnIiOmZhbHNlLCJ3Ym1zZyI6ZmFsc2UsInNmaWQiOiIxYmVmOTdkMS0wNzA0LTRlYjItYTQ5MC1hOGYyMDA3Njc1ZGIiLCJ1cmxleHAiOm51bGwsImF0aCI6bnVsbCwiZHQiOiJUZXN0IGRvY3VtZW50IiwidmYiOmZhbHNlLCJhbiI6IklkZnkgU0RLIGRlbW8iLCJ0aCI6IlBpbmsiLCJzcCI6IkN1YmVzIiwiZG9tIjpudWxsLCJyZGlyIjpmYWxzZSwidXQiOiJ3ZWIiLCJ1dHYiOm51bGwsInNtIjoidGVzdEB0ZXN0LmNvbSJ9.Dyy2RSeR6dmU8qxOEi-2gEX3Gg7wry6JhkZIWOuADDdu5jJWidQLcxfJn_qAHNpb","links":[],"externalSignerId":"uoiahsd321982983jhrmnec2wsadm32","redirectSettings":{"redirectMode":"donot_redirect"},"signatureType":{"mechanism":"pkisignature","onEacceptUseHandWrittenSignature":false},"ui":{"dialogs":{"before":{"useCheckBox":false,"title":"Info","message":"Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."}},"language":"EN","styling":{"colorTheme":"Pink","spinner":"Cubes"}},"tags":[],"order":0,"required":false}Complex5Class NameComplex5FieldsNameTypeTagsDescriptionresponse_dataResponseData-response_detailsstringOptional-response_statusint-Example (as JSON){"responseData":{"feed":{"feedUrl":"http://ramrojob.com/feed","title":"Ramro Job","link":"http://ramrojob.com","author":"","description":"...your pathway to success","type":"rss20","entries":[{"title":"Monitoring and Evaluation Specialist Wanted at GRM International","link":"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 01:10:24 -0700","contentSnippet":"Key Responsibilities Under direction of the Team Leader, responsible for the design and roll out of programme M&#38;E plan, ...","content":"<p><strong>Key Responsibilities</strong></p>\n<ul>\n<li>Under direction of the Team Leader, responsible for the design and roll out of programme M&amp;E plan, including design of the logframe and key performance indicators.</li>\n<li>Track programme progress against indicators and ensure early identification of any areas requiring remedial action.</li>\n<li>Carry out site visits and provide M&amp;E support and training for local partners.</li>\n<li>Harmonise programme monitoring indicators and systems with national M&amp;E systems.</li>\n<li>Promote use of data to inform decision making and link evidence-based approaches to achievement of results.</li>\n<li>Support operations research and specialised studies, such as client satisfaction, cost-effectiveness, and impact evaluation.</li>\n<li>Solicit and manage local data collection and research teams, as needed.</li>\n<li>Contribute to the preparation of regular progress reports, technical deliverables, presentations, and annual work plans.</li>\n</ul>\n<p><strong>Qualifications</strong></p>\n<ul>\n<li>Seven or more years of experience monitoring and evaluating reproductive health and family planning programmes, including promoting use of data for decision-making.</li>\n<li>Strong technical grasp of relevant health issues: sexual and reproductive health; family planning; maternal, new-born, and child health; HIV and AIDS; and health equity.</li>\n<li>Understanding of health market dynamics and the health system in Nepal.</li>\n<li>Demonstrated experience working with government, private sector, and nongovernmental health sector partners in Nepal, at national and decentralised levels.</li>\n<li>Experience supporting DFID, European Union, USAID, World Bank, or other donor-funded or government health programmes.</li>\n<li>Strong quantitative and qualitative research and analysis skills.</li>\n<li>Demonstrated experience with computerised management information systems, databases, MS Office, and other relevant skills.</li>\n<li>Ability to graphically present data in ways that engage and influence target audiences.</li>\n<li>Knowledge of in-country and international guidelines pertaining to research ethics.</li>\n<li>Strong personal qualities, including integrity, commitment to excellence, equality, openness, inclusiveness, and collegiality.</li>\n<li>Excellent written and spoken English required, local languages are a distinct advantage.</li>\n<li>Advanced degree/s in relevant discipline preferred.</li>\n<li>Nepali nationals strongly encouraged to apply.</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html\">Monitoring and Evaluation Specialist Wanted at GRM International</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Director of Finance and Admin Wanted at Abt Associates","link":"http://ramrojob.com/job/2013/05/12/director-of-finance-and-admin-wanted-at-abt-associates.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 01:02:28 -0700","contentSnippet":"Job Responsibilities: Abt Associates seeks a Director of Finance and Administration for an upcoming DFID-funded family planning ...","content":"<p><strong>Job Responsibilities:</strong></p>\n<p>Abt Associates seeks a Director of Finance and Administration for an upcoming DFID-funded family planning program in Nepal. The initiative will work with the Ministry of Health and Population to increase use of modern high-quality family planning methods by the most vulnerable and excluded women by supply innovative and high quality family planning services. The program will also work with the Ministry of Health and Population to ensure better choices and availabilites of reproductive health commodities.</p>\n<p>The Director of Finance and Administration will be responsible for the management of the contract, procurement, subcontracting, financial management and reporting, and general administrative support of the program. S/he will develop and track budgets, manage payroll and vendor relations, and control all financial transactions and reporting, both for the client and for Abt Associates headquarters.</p>\n<p>Specific responsibilities will include:</p>\n<ul>\n<li>Ensure compliance with terms and references in the contract;</li>\n<li>Develop and implement financial and administrative policies and procedures that meet project requirements and donor regulations;</li>\n<li>Create and maintain financial reporting and tracking systems, and provide financial performance updates on project activities;</li>\n<li>Prepare budgets and revenue plans for project programming and corporate reporting;</li>\n<li>Oversee financial and HR administration of project (purchase requisitions, consulting agreements, vendor invoices, client invoices, payroll etc.);</li>\n<li>Manage vendors and subcontractors in compliance with Abt and DfID policies and regulations;</li>\n<li>Supervise all financial and administrative staff;</li>\n<li>Provide training to field staff on project procedures as well as building skill-levels of project staff in the area of finance, administration, and project management.</li>\n</ul>\n<p><strong>Skills Prerequisites:</strong></p>\n<ul>\n<li>Bachelorï¿½s Degree (minimum) or masterï¿½s degree (preferred) in Business, Finance, Accounting or other relevant field;</li>\n<li>10 years of experience in administration, project management and/or financial management;</li>\n<li>5 years of experience working with international donors in a development setting;</li>\n<li>Experience with DfID contracts desirable;</li>\n<li>Strong analytical and computer skills, with emphasis on budgeting and financial analysis;</li>\n<li>Excellent inter-personal, communication and organizational skills;</li>\n<li>Capabilities in Nepali or other South Asian languages are desirable.</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/director-of-finance-and-admin-wanted-at-abt-associates.html\">Director of Finance and Admin Wanted at Abt Associates</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Technical Director Wanted at Family Planning Nepal","link":"http://ramrojob.com/job/2013/05/12/technical-director-wanted-at-family-planning-nepal.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 00:57:03 -0700","contentSnippet":"Skills Prerequisites: Masters Degree (minimum) in Public Health, Business Administration or related relevant discipline Ten ...","content":"<p><strong>Skills Prerequisites:</strong></p>\n<ul>\n<li>Masters Degree (minimum) in Public Health, Business Administration or related relevant discipline</li>\n<li>Ten years (10) of relevant professional experience, including sales or marketing, and strong business acumen in areas of business process and analysis would be highly valued</li>\n<li>Eight (8) years experience working in health sector projects or initiatives involving multiple stakeholder groups, including NGOs and the private health sector</li>\n<li>Successful prior experience in social marketing or franchising</li>\n<li>Proven track record of building and sustaining effective partnerships, advocating effectively and communicating to various constituencies</li>\n<li>Ability to coordinate in a dynamic environment</li>\n<li>Substantial experience in building capacity in the non-state/private sector</li>\n<li>Ability to independently plan and execute complex tasks while addressing daily management details and remaining organized and focused on long-term deadlines and strategies</li>\n<li>Solid professional reputation and strong, demonstrated interpersonal skills</li>\n<li>Professional working experience in Nepal desirable</li>\n<li>Fluency in Nepali desirable</li>\n<li>Excellent written and oral presentation skills in English</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/technical-director-wanted-at-family-planning-nepal.html\">Technical Director Wanted at Family Planning Nepal</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Monitoring and Evaluation Analyst Wanted at UN Women","link":"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-analyst-wanted-at-un-women.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 00:46:37 -0700","contentSnippet":"Core Competencies Knowledge of current practices in the area of monitoring and evaluation, knowledge management Promotes the ...","content":"<p><b>Core Competencies</b></p>\n<ul>\n<li>Knowledge of current practices in the area of monitoring and evaluation, knowledge management</li>\n<li>Promotes the vision, mission, and strategic goals of UN Women;</li>\n<li>Displays cultural, gender, religion, race, nationality and age sensitivity and adaptability</li>\n<li>Fostering innovation and empowerment</li>\n<li>Working in teams at all levels</li>\n<li>Communicating information and ideas/knowledge sharing</li>\n<li>Analytical and strategic thinking/results orientation/commitment to Excellence</li>\n</ul>\n<p><span style=\"text-decoration:underline\"><strong>Qualifications and Experience:</strong></span></p>\n<ul>\n<li>Masterï¿½s Degree in Economics, Management, Rural Development, Social Sciences, or related field. Additional certification in statistics, MIS management and Monitoring and Evaluation will be considered as an asset.</li>\n<li>Two years of relevant professional experience in the field of rights based monitoring and evaluation;</li>\n<li>Experience in the management of gender equality and womenï¿½s empowerment programmes or analytic work in gender and development, gender analysis and/or human rights;</li>\n<li> Good knowledge of rights-based approach and result-based management.</li>\n<li> Experience related to UN Womenï¿½s mandate and activities would be an added advantage;</li>\n<li> Sound knowledge of international standards on human rights, womenï¿½s rights and related instruments;</li>\n<li>A proven ability to liaise with a myriad of stakeholders and partners, including government, civil society, international organizations and grassroots organizations</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-analyst-wanted-at-un-women.html\">Monitoring and Evaluation Analyst Wanted at UN Women</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["The Himalayan Times"]}]}},"responseStatus":200}ResponseDataClass NameResponseDataFieldsNameTypeDescriptionfeedFeed-Example (as JSON){"feed":{"feedUrl":"http://ramrojob.com/feed","title":"Ramro Job","link":"http://ramrojob.com","author":"","description":"...your pathway to success","type":"rss20","entries":[{"title":"Monitoring and Evaluation Specialist Wanted at GRM International","link":"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 01:10:24 -0700","contentSnippet":"Key Responsibilities Under direction of the Team Leader, responsible for the design and roll out of programme M&#38;E plan, ...","content":"<p><strong>Key Responsibilities</strong></p>\n<ul>\n<li>Under direction of the Team Leader, responsible for the design and roll out of programme M&amp;E plan, including design of the logframe and key performance indicators.</li>\n<li>Track programme progress against indicators and ensure early identification of any areas requiring remedial action.</li>\n<li>Carry out site visits and provide M&amp;E support and training for local partners.</li>\n<li>Harmonise programme monitoring indicators and systems with national M&amp;E systems.</li>\n<li>Promote use of data to inform decision making and link evidence-based approaches to achievement of results.</li>\n<li>Support operations research and specialised studies, such as client satisfaction, cost-effectiveness, and impact evaluation.</li>\n<li>Solicit and manage local data collection and research teams, as needed.</li>\n<li>Contribute to the preparation of regular progress reports, technical deliverables, presentations, and annual work plans.</li>\n</ul>\n<p><strong>Qualifications</strong></p>\n<ul>\n<li>Seven or more years of experience monitoring and evaluating reproductive health and family planning programmes, including promoting use of data for decision-making.</li>\n<li>Strong technical grasp of relevant health issues: sexual and reproductive health; family planning; maternal, new-born, and child health; HIV and AIDS; and health equity.</li>\n<li>Understanding of health market dynamics and the health system in Nepal.</li>\n<li>Demonstrated experience working with government, private sector, and nongovernmental health sector partners in Nepal, at national and decentralised levels.</li>\n<li>Experience supporting DFID, European Union, USAID, World Bank, or other donor-funded or government health programmes.</li>\n<li>Strong quantitative and qualitative research and analysis skills.</li>\n<li>Demonstrated experience with computerised management information systems, databases, MS Office, and other relevant skills.</li>\n<li>Ability to graphically present data in ways that engage and influence target audiences.</li>\n<li>Knowledge of in-country and international guidelines pertaining to research ethics.</li>\n<li>Strong personal qualities, including integrity, commitment to excellence, equality, openness, inclusiveness, and collegiality.</li>\n<li>Excellent written and spoken English required, local languages are a distinct advantage.</li>\n<li>Advanced degree/s in relevant discipline preferred.</li>\n<li>Nepali nationals strongly encouraged to apply.</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html\">Monitoring and Evaluation Specialist Wanted at GRM International</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Director of Finance and Admin Wanted at Abt Associates","link":"http://ramrojob.com/job/2013/05/12/director-of-finance-and-admin-wanted-at-abt-associates.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 01:02:28 -0700","contentSnippet":"Job Responsibilities: Abt Associates seeks a Director of Finance and Administration for an upcoming DFID-funded family planning ...","content":"<p><strong>Job Responsibilities:</strong></p>\n<p>Abt Associates seeks a Director of Finance and Administration for an upcoming DFID-funded family planning program in Nepal. The initiative will work with the Ministry of Health and Population to increase use of modern high-quality family planning methods by the most vulnerable and excluded women by supply innovative and high quality family planning services. The program will also work with the Ministry of Health and Population to ensure better choices and availabilites of reproductive health commodities.</p>\n<p>The Director of Finance and Administration will be responsible for the management of the contract, procurement, subcontracting, financial management and reporting, and general administrative support of the program. S/he will develop and track budgets, manage payroll and vendor relations, and control all financial transactions and reporting, both for the client and for Abt Associates headquarters.</p>\n<p>Specific responsibilities will include:</p>\n<ul>\n<li>Ensure compliance with terms and references in the contract;</li>\n<li>Develop and implement financial and administrative policies and procedures that meet project requirements and donor regulations;</li>\n<li>Create and maintain financial reporting and tracking systems, and provide financial performance updates on project activities;</li>\n<li>Prepare budgets and revenue plans for project programming and corporate reporting;</li>\n<li>Oversee financial and HR administration of project (purchase requisitions, consulting agreements, vendor invoices, client invoices, payroll etc.);</li>\n<li>Manage vendors and subcontractors in compliance with Abt and DfID policies and regulations;</li>\n<li>Supervise all financial and administrative staff;</li>\n<li>Provide training to field staff on project procedures as well as building skill-levels of project staff in the area of finance, administration, and project management.</li>\n</ul>\n<p><strong>Skills Prerequisites:</strong></p>\n<ul>\n<li>Bachelorï¿½s Degree (minimum) or masterï¿½s degree (preferred) in Business, Finance, Accounting or other relevant field;</li>\n<li>10 years of experience in administration, project management and/or financial management;</li>\n<li>5 years of experience working with international donors in a development setting;</li>\n<li>Experience with DfID contracts desirable;</li>\n<li>Strong analytical and computer skills, with emphasis on budgeting and financial analysis;</li>\n<li>Excellent inter-personal, communication and organizational skills;</li>\n<li>Capabilities in Nepali or other South Asian languages are desirable.</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/director-of-finance-and-admin-wanted-at-abt-associates.html\">Director of Finance and Admin Wanted at Abt Associates</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Technical Director Wanted at Family Planning Nepal","link":"http://ramrojob.com/job/2013/05/12/technical-director-wanted-at-family-planning-nepal.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 00:57:03 -0700","contentSnippet":"Skills Prerequisites: Masters Degree (minimum) in Public Health, Business Administration or related relevant discipline Ten ...","content":"<p><strong>Skills Prerequisites:</strong></p>\n<ul>\n<li>Masters Degree (minimum) in Public Health, Business Administration or related relevant discipline</li>\n<li>Ten years (10) of relevant professional experience, including sales or marketing, and strong business acumen in areas of business process and analysis would be highly valued</li>\n<li>Eight (8) years experience working in health sector projects or initiatives involving multiple stakeholder groups, including NGOs and the private health sector</li>\n<li>Successful prior experience in social marketing or franchising</li>\n<li>Proven track record of building and sustaining effective partnerships, advocating effectively and communicating to various constituencies</li>\n<li>Ability to coordinate in a dynamic environment</li>\n<li>Substantial experience in building capacity in the non-state/private sector</li>\n<li>Ability to independently plan and execute complex tasks while addressing daily management details and remaining organized and focused on long-term deadlines and strategies</li>\n<li>Solid professional reputation and strong, demonstrated interpersonal skills</li>\n<li>Professional working experience in Nepal desirable</li>\n<li>Fluency in Nepali desirable</li>\n<li>Excellent written and oral presentation skills in English</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/technical-director-wanted-at-family-planning-nepal.html\">Technical Director Wanted at Family Planning Nepal</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Monitoring and Evaluation Analyst Wanted at UN Women","link":"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-analyst-wanted-at-un-women.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 00:46:37 -0700","contentSnippet":"Core Competencies Knowledge of current practices in the area of monitoring and evaluation, knowledge management Promotes the ...","content":"<p><b>Core Competencies</b></p>\n<ul>\n<li>Knowledge of current practices in the area of monitoring and evaluation, knowledge management</li>\n<li>Promotes the vision, mission, and strategic goals of UN Women;</li>\n<li>Displays cultural, gender, religion, race, nationality and age sensitivity and adaptability</li>\n<li>Fostering innovation and empowerment</li>\n<li>Working in teams at all levels</li>\n<li>Communicating information and ideas/knowledge sharing</li>\n<li>Analytical and strategic thinking/results orientation/commitment to Excellence</li>\n</ul>\n<p><span style=\"text-decoration:underline\"><strong>Qualifications and Experience:</strong></span></p>\n<ul>\n<li>Masterï¿½s Degree in Economics, Management, Rural Development, Social Sciences, or related field. Additional certification in statistics, MIS management and Monitoring and Evaluation will be considered as an asset.</li>\n<li>Two years of relevant professional experience in the field of rights based monitoring and evaluation;</li>\n<li>Experience in the management of gender equality and womenï¿½s empowerment programmes or analytic work in gender and development, gender analysis and/or human rights;</li>\n<li> Good knowledge of rights-based approach and result-based management.</li>\n<li> Experience related to UN Womenï¿½s mandate and activities would be an added advantage;</li>\n<li> Sound knowledge of international standards on human rights, womenï¿½s rights and related instruments;</li>\n<li>A proven ability to liaise with a myriad of stakeholders and partners, including government, civil society, international organizations and grassroots organizations</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-analyst-wanted-at-un-women.html\">Monitoring and Evaluation Analyst Wanted at UN Women</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["The Himalayan Times"]}]}}FeedClass NameFeedFieldsNameTypeDescriptionfeed_urlstring-titlestring-linkstring-authorstring-descriptionstring-mtypestring-entriesList of Entry-Example (as JSON){"feedUrl":"http://ramrojob.com/feed","title":"Ramro Job","link":"http://ramrojob.com","author":"","description":"...your pathway to success","type":"rss20","entries":[{"title":"Monitoring and Evaluation Specialist Wanted at GRM International","link":"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 01:10:24 -0700","contentSnippet":"Key Responsibilities Under direction of the Team Leader, responsible for the design and roll out of programme M&#38;E plan, ...","content":"<p><strong>Key Responsibilities</strong></p>\n<ul>\n<li>Under direction of the Team Leader, responsible for the design and roll out of programme M&amp;E plan, including design of the logframe and key performance indicators.</li>\n<li>Track programme progress against indicators and ensure early identification of any areas requiring remedial action.</li>\n<li>Carry out site visits and provide M&amp;E support and training for local partners.</li>\n<li>Harmonise programme monitoring indicators and systems with national M&amp;E systems.</li>\n<li>Promote use of data to inform decision making and link evidence-based approaches to achievement of results.</li>\n<li>Support operations research and specialised studies, such as client satisfaction, cost-effectiveness, and impact evaluation.</li>\n<li>Solicit and manage local data collection and research teams, as needed.</li>\n<li>Contribute to the preparation of regular progress reports, technical deliverables, presentations, and annual work plans.</li>\n</ul>\n<p><strong>Qualifications</strong></p>\n<ul>\n<li>Seven or more years of experience monitoring and evaluating reproductive health and family planning programmes, including promoting use of data for decision-making.</li>\n<li>Strong technical grasp of relevant health issues: sexual and reproductive health; family planning; maternal, new-born, and child health; HIV and AIDS; and health equity.</li>\n<li>Understanding of health market dynamics and the health system in Nepal.</li>\n<li>Demonstrated experience working with government, private sector, and nongovernmental health sector partners in Nepal, at national and decentralised levels.</li>\n<li>Experience supporting DFID, European Union, USAID, World Bank, or other donor-funded or government health programmes.</li>\n<li>Strong quantitative and qualitative research and analysis skills.</li>\n<li>Demonstrated experience with computerised management information systems, databases, MS Office, and other relevant skills.</li>\n<li>Ability to graphically present data in ways that engage and influence target audiences.</li>\n<li>Knowledge of in-country and international guidelines pertaining to research ethics.</li>\n<li>Strong personal qualities, including integrity, commitment to excellence, equality, openness, inclusiveness, and collegiality.</li>\n<li>Excellent written and spoken English required, local languages are a distinct advantage.</li>\n<li>Advanced degree/s in relevant discipline preferred.</li>\n<li>Nepali nationals strongly encouraged to apply.</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html\">Monitoring and Evaluation Specialist Wanted at GRM International</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Director of Finance and Admin Wanted at Abt Associates","link":"http://ramrojob.com/job/2013/05/12/director-of-finance-and-admin-wanted-at-abt-associates.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 01:02:28 -0700","contentSnippet":"Job Responsibilities: Abt Associates seeks a Director of Finance and Administration for an upcoming DFID-funded family planning ...","content":"<p><strong>Job Responsibilities:</strong></p>\n<p>Abt Associates seeks a Director of Finance and Administration for an upcoming DFID-funded family planning program in Nepal. The initiative will work with the Ministry of Health and Population to increase use of modern high-quality family planning methods by the most vulnerable and excluded women by supply innovative and high quality family planning services. The program will also work with the Ministry of Health and Population to ensure better choices and availabilites of reproductive health commodities.</p>\n<p>The Director of Finance and Administration will be responsible for the management of the contract, procurement, subcontracting, financial management and reporting, and general administrative support of the program. S/he will develop and track budgets, manage payroll and vendor relations, and control all financial transactions and reporting, both for the client and for Abt Associates headquarters.</p>\n<p>Specific responsibilities will include:</p>\n<ul>\n<li>Ensure compliance with terms and references in the contract;</li>\n<li>Develop and implement financial and administrative policies and procedures that meet project requirements and donor regulations;</li>\n<li>Create and maintain financial reporting and tracking systems, and provide financial performance updates on project activities;</li>\n<li>Prepare budgets and revenue plans for project programming and corporate reporting;</li>\n<li>Oversee financial and HR administration of project (purchase requisitions, consulting agreements, vendor invoices, client invoices, payroll etc.);</li>\n<li>Manage vendors and subcontractors in compliance with Abt and DfID policies and regulations;</li>\n<li>Supervise all financial and administrative staff;</li>\n<li>Provide training to field staff on project procedures as well as building skill-levels of project staff in the area of finance, administration, and project management.</li>\n</ul>\n<p><strong>Skills Prerequisites:</strong></p>\n<ul>\n<li>Bachelorï¿½s Degree (minimum) or masterï¿½s degree (preferred) in Business, Finance, Accounting or other relevant field;</li>\n<li>10 years of experience in administration, project management and/or financial management;</li>\n<li>5 years of experience working with international donors in a development setting;</li>\n<li>Experience with DfID contracts desirable;</li>\n<li>Strong analytical and computer skills, with emphasis on budgeting and financial analysis;</li>\n<li>Excellent inter-personal, communication and organizational skills;</li>\n<li>Capabilities in Nepali or other South Asian languages are desirable.</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/director-of-finance-and-admin-wanted-at-abt-associates.html\">Director of Finance and Admin Wanted at Abt Associates</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Technical Director Wanted at Family Planning Nepal","link":"http://ramrojob.com/job/2013/05/12/technical-director-wanted-at-family-planning-nepal.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 00:57:03 -0700","contentSnippet":"Skills Prerequisites: Masters Degree (minimum) in Public Health, Business Administration or related relevant discipline Ten ...","content":"<p><strong>Skills Prerequisites:</strong></p>\n<ul>\n<li>Masters Degree (minimum) in Public Health, Business Administration or related relevant discipline</li>\n<li>Ten years (10) of relevant professional experience, including sales or marketing, and strong business acumen in areas of business process and analysis would be highly valued</li>\n<li>Eight (8) years experience working in health sector projects or initiatives involving multiple stakeholder groups, including NGOs and the private health sector</li>\n<li>Successful prior experience in social marketing or franchising</li>\n<li>Proven track record of building and sustaining effective partnerships, advocating effectively and communicating to various constituencies</li>\n<li>Ability to coordinate in a dynamic environment</li>\n<li>Substantial experience in building capacity in the non-state/private sector</li>\n<li>Ability to independently plan and execute complex tasks while addressing daily management details and remaining organized and focused on long-term deadlines and strategies</li>\n<li>Solid professional reputation and strong, demonstrated interpersonal skills</li>\n<li>Professional working experience in Nepal desirable</li>\n<li>Fluency in Nepali desirable</li>\n<li>Excellent written and oral presentation skills in English</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/technical-director-wanted-at-family-planning-nepal.html\">Technical Director Wanted at Family Planning Nepal</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]},{"title":"Monitoring and Evaluation Analyst Wanted at UN Women","link":"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-analyst-wanted-at-un-women.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 00:46:37 -0700","contentSnippet":"Core Competencies Knowledge of current practices in the area of monitoring and evaluation, knowledge management Promotes the ...","content":"<p><b>Core Competencies</b></p>\n<ul>\n<li>Knowledge of current practices in the area of monitoring and evaluation, knowledge management</li>\n<li>Promotes the vision, mission, and strategic goals of UN Women;</li>\n<li>Displays cultural, gender, religion, race, nationality and age sensitivity and adaptability</li>\n<li>Fostering innovation and empowerment</li>\n<li>Working in teams at all levels</li>\n<li>Communicating information and ideas/knowledge sharing</li>\n<li>Analytical and strategic thinking/results orientation/commitment to Excellence</li>\n</ul>\n<p><span style=\"text-decoration:underline\"><strong>Qualifications and Experience:</strong></span></p>\n<ul>\n<li>Masterï¿½s Degree in Economics, Management, Rural Development, Social Sciences, or related field. Additional certification in statistics, MIS management and Monitoring and Evaluation will be considered as an asset.</li>\n<li>Two years of relevant professional experience in the field of rights based monitoring and evaluation;</li>\n<li>Experience in the management of gender equality and womenï¿½s empowerment programmes or analytic work in gender and development, gender analysis and/or human rights;</li>\n<li> Good knowledge of rights-based approach and result-based management.</li>\n<li> Experience related to UN Womenï¿½s mandate and activities would be an added advantage;</li>\n<li> Sound knowledge of international standards on human rights, womenï¿½s rights and related instruments;</li>\n<li>A proven ability to liaise with a myriad of stakeholders and partners, including government, civil society, international organizations and grassroots organizations</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-analyst-wanted-at-un-women.html\">Monitoring and Evaluation Analyst Wanted at UN Women</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["The Himalayan Times"]}]}EntryClass NameEntryFieldsNameTypeDescriptiontitlestring-linkstring-authorstring-published_datestring-content_snippetstring-contentstring-categoriesList of string-Example (as JSON){"title":"Monitoring and Evaluation Specialist Wanted at GRM International","link":"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html","author":"Bandana Aryal","publishedDate":"Sun, 12 May 2013 01:10:24 -0700","contentSnippet":"Key Responsibilities Under direction of the Team Leader, responsible for the design and roll out of programme M&#38;E plan, ...","content":"<p><strong>Key Responsibilities</strong></p>\n<ul>\n<li>Under direction of the Team Leader, responsible for the design and roll out of programme M&amp;E plan, including design of the logframe and key performance indicators.</li>\n<li>Track programme progress against indicators and ensure early identification of any areas requiring remedial action.</li>\n<li>Carry out site visits and provide M&amp;E support and training for local partners.</li>\n<li>Harmonise programme monitoring indicators and systems with national M&amp;E systems.</li>\n<li>Promote use of data to inform decision making and link evidence-based approaches to achievement of results.</li>\n<li>Support operations research and specialised studies, such as client satisfaction, cost-effectiveness, and impact evaluation.</li>\n<li>Solicit and manage local data collection and research teams, as needed.</li>\n<li>Contribute to the preparation of regular progress reports, technical deliverables, presentations, and annual work plans.</li>\n</ul>\n<p><strong>Qualifications</strong></p>\n<ul>\n<li>Seven or more years of experience monitoring and evaluating reproductive health and family planning programmes, including promoting use of data for decision-making.</li>\n<li>Strong technical grasp of relevant health issues: sexual and reproductive health; family planning; maternal, new-born, and child health; HIV and AIDS; and health equity.</li>\n<li>Understanding of health market dynamics and the health system in Nepal.</li>\n<li>Demonstrated experience working with government, private sector, and nongovernmental health sector partners in Nepal, at national and decentralised levels.</li>\n<li>Experience supporting DFID, European Union, USAID, World Bank, or other donor-funded or government health programmes.</li>\n<li>Strong quantitative and qualitative research and analysis skills.</li>\n<li>Demonstrated experience with computerised management information systems, databases, MS Office, and other relevant skills.</li>\n<li>Ability to graphically present data in ways that engage and influence target audiences.</li>\n<li>Knowledge of in-country and international guidelines pertaining to research ethics.</li>\n<li>Strong personal qualities, including integrity, commitment to excellence, equality, openness, inclusiveness, and collegiality.</li>\n<li>Excellent written and spoken English required, local languages are a distinct advantage.</li>\n<li>Advanced degree/s in relevant discipline preferred.</li>\n<li>Nepali nationals strongly encouraged to apply.</li>\n</ul>\n<p>The post <a href=\"http://ramrojob.com/job/2013/05/12/monitoring-and-evaluation-specialist-wanted-at-grm-international.html\">Monitoring and Evaluation Specialist Wanted at GRM International</a> appeared first on <a href=\"http://ramrojob.com\">Ramro Job</a>.</p>","categories":["Uncategorized"]}DateAsOptionalClass NameDateAsOptionalFieldsNameTypeTagsDescriptiondatedateOptional-Example (as JSON){"date":null}AddPrecisionInExceptionClass NameAddPrecisionInExceptionFieldsNameTypeTagsDescriptionvaluefloat-value_1floatOptional-Example (as JSON){"value":1.23}AddUuidInGlobalExceptionClass NameAddUuidInGlobalExceptionFieldsNameTypeTagsDescriptionvalue`uuidstring`value_1`uuidstring`OptionalExample (as JSON){"value":"123e4567-e89b-12d3-a456-426655440000"}AddRfc1123DatetimeInGlobalExceptionClass NameAddRfc1123DatetimeInGlobalExceptionFieldsNameTypeTagsDescriptiondate_timedatetime-date_time_1datetimeOptional-Example (as JSON){"dateTime":"Sun, 06 Nov 1994 08:49:37 GMT"}AddNumberInExceptionClass NameAddNumberInExceptionFieldsNameTypeTagsDescriptionvalueint-value_1intOptional-Example (as JSON){"value":1}AddDynamicInExceptionClass NameAddDynamicInExceptionFieldsNameTypeTagsDescriptionvalueobject-value_1objectOptional-Example (as JSON){"value":" {\r\n\t\t\t\"value\" : \"test\"\r\n\t\t}"}AddRfc3339DatetimeInGlobalExceptionClass NameAddRfc3339DatetimeInGlobalExceptionFieldsNameTypeTagsDescriptiondate_timedatetime-date_time_1datetimeOptional-Example (as JSON){"dateTime":"2016-03-13T12:52:32.123Z","dateTime1":null}AddBooleanInGlobalExceptionClass NameAddBooleanInGlobalExceptionFieldsNameTypeTagsDescriptionvaluebool-value_1boolOptional-Example (as JSON){"value":false,"value1":null}AddDateInGlobalExceptionClass NameAddDateInGlobalExceptionFieldsNameTypeTagsDescriptionvaluedate-value_1dateOptional-Example (as JSON){"value":"1994-02-13"}AddStringInGlobalExceptionClass NameAddStringInGlobalExceptionFieldsNameTypeTagsDescriptionvaluestring-value_1stringOptional-Example (as JSON){"value":"test"}AddUnixTimeStampInGlobalExceptionClass NameAddUnixTimeStampInGlobalExceptionFieldsNameTypeTagsDescriptiondate_timedatetime-date_time_1datetimeOptional-Example (as JSON){"dateTime":1484719381}AddLongInGlobalExceptionClass NameAddLongInGlobalExceptionFieldsNameTypeTagsDescriptionvalue`longint`value_1`longint`OptionalExample (as JSON){"value":123123}EnumerationsDaysSuiteCodeParamFormatTypeLanguageEnumTeamTeamIntegerDaysA string enum representing days of the weekClass NameDaysFieldsNameDescriptionSUNDAY-MONDAY-TUESDAY-WEDNESDAY_-THURSDAY-FRI_DAY-SATURDAY-SuiteCodeA integer based enum representing a Suite in a game of cardsClass NameSuiteCodeFieldsNameDescriptionHEARTS-SPADES-CLUBS-DIAMONDS-ParamFormatClass NameParamFormatFieldsNameDescriptionTEMPLATE-FORM-BODY-HEADER-QUERY-TypeClass NameTypeFieldsNameDescriptionLONG-NUMBER-PRECISION-BOOLEAN-DATETIME-DATE-STRING-LanguageEnumClass NameLanguageEnumFieldsNameDescriptionEN-DZ-NL-TeamClass NameTeamFieldsNameDescriptionCODEGEN-CGAAS-UX-QA-TeamIntegerClass NameTeamIntegerFieldsNameDescriptionCODEGEN-CGAAS-UX-QA-ExceptionsLocalTestExceptionGlobalTestExceptionNestedModelExceptionRfc1123ExceptionUnixTimeStampExceptionExceptionWithRfc3339DateTimeExceptionExceptionWithDateExceptionExceptionWithUUIDExceptionExceptionWithDynamicExceptionExceptionWithPrecisionExceptionExceptionWithBooleanExceptionExceptionWithLongExceptionExceptionWithNumberExceptionExceptionWithStringExceptionCustomErrorResponseExceptionSendUuidInModelAsExceptionSendPrecisionInModelAsExceptionSendNumberInModelAsExceptionSendLongInModelAsExceptionSendStringInModelAsExceptionSendDynamicInModelAsExceptionSendDateInModelAsExceptionSendUnixTimeStampInModelAsExceptionSendRfc3339InModelAsExceptionSendRfc1123InModelAsExceptionSendBooleanInModelAsExceptionComplexObjectInExceptionEnumInExceptionLocalTestExceptionTo test specific local exceptions.Class NameLocalTestExceptionInherits FromGlobalTestExceptionFieldsNameTypeDescriptionsecret_message_for_endpointstringRepresents the specific endpoint infoExample (as JSON){"SecretMessageForEndpoint":"SecretMessageForEndpoint6","ServerMessage":"ServerMessage6","ServerCode":170}GlobalTestExceptionTo test specific global exceptions.Class NameGlobalTestExceptionFieldsNameTypeDescriptionserver_messagestringRepresents the server's exception messageserver_codeintRepresents the server's error codeExample (as JSON){"ServerMessage":"ServerMessage6","ServerCode":170}NestedModelExceptionClass NameNestedModelExceptionFieldsNameTypeDescriptionserver_messagestring-server_codestring-modelValidate-Example (as JSON){"ServerMessage":"ServerMessage6","ServerCode":"ServerCode0","model":{"field":"field4","name":"name2","address":null}}Rfc1123ExceptionClass NameRfc1123ExceptionFieldsNameTypeTagsDescriptiondate_timedatetime-date_time_1datetimeOptional-Example (as JSON){"dateTime":"Sun, 06 Nov 1994 08:49:37 GMT"}UnixTimeStampExceptionClass NameUnixTimeStampExceptionFieldsNameTypeTagsDescriptiondate_timedatetime-date_time_1datetimeOptional-Example (as JSON){"dateTime":1484719381}ExceptionWithRfc3339DateTimeExceptionClass NameExceptionWithRfc3339DateTimeExceptionFieldsNameTypeTagsDescriptiondate_timedatetime-date_time_1datetimeOptional-Example (as JSON){"dateTime":"2016-03-13T12:52:32.123Z","dateTime1":null}ExceptionWithDateExceptionClass NameExceptionWithDateExceptionFieldsNameTypeTagsDescriptionvaluedate-value_1dateOptional-Example (as JSON){"value":"1994-02-13"}ExceptionWithUUIDExceptionClass NameExceptionWithUUIDExceptionFieldsNameTypeTagsDescriptionvalue`uuidstring`value_1`uuidstring`OptionalExample (as JSON){"value":"123e4567-e89b-12d3-a456-426655440000"}ExceptionWithDynamicExceptionClass NameExceptionWithDynamicExceptionFieldsNameTypeTagsDescriptionvalueobject-value_1objectOptional-Example (as JSON){"value":"{\n  \"value\" : \"test\"\n}"}ExceptionWithPrecisionExceptionClass NameExceptionWithPrecisionExceptionFieldsNameTypeTagsDescriptionvaluefloat-value_1floatOptional-Example (as JSON){"value":1.23}ExceptionWithBooleanExceptionClass NameExceptionWithBooleanExceptionFieldsNameTypeTagsDescriptionvaluebool-value_1boolOptional-Example (as JSON){"value":true}ExceptionWithLongExceptionClass NameExceptionWithLongExceptionFieldsNameTypeTagsDescriptionvalue`longint`value_1`longint`OptionalExample (as JSON){"value":12312312}ExceptionWithNumberExceptionClass NameExceptionWithNumberExceptionFieldsNameTypeTagsDescriptionvalueint-value_1intOptional-Example (as JSON){"value":1}ExceptionWithStringExceptionClass NameExceptionWithStringExceptionFieldsNameTypeTagsDescriptionvaluestring-value_1stringOptional-Example (as JSON){"value":"test"}CustomErrorResponseExceptionClass NameCustomErrorResponseExceptionFieldsNameTypeDescriptionerror_descriptionstring-caughtstring-exceptionstring-inner_exceptionstring-Example (as JSON){"error description":null,"caught":"Error in CatchInner caused by calling the ThrowInner method.","Exception":"In catch block of Main method.","Inner Exception":"AppException: Exception in ThrowInner method."}SendUuidInModelAsExceptionClass NameSendUuidInModelAsExceptionFieldsNameTypeDescriptionbodyAddUuidInGlobalException-Example (as JSON){"body":{"value":"123e4567-e89b-12d3-a456-426655440000"}}SendPrecisionInModelAsExceptionClass NameSendPrecisionInModelAsExceptionFieldsNameTypeDescriptionbodyAddPrecisionInException-Example (as JSON){"body":{"value":1.23}}SendNumberInModelAsExceptionClass NameSendNumberInModelAsExceptionFieldsNameTypeDescriptionbodyAddNumberInException-Example (as JSON){"body":{"value":1}}SendLongInModelAsExceptionClass NameSendLongInModelAsExceptionFieldsNameTypeDescriptionbodyAddLongInGlobalException-Example (as JSON){"body":{"value":123123}}SendStringInModelAsExceptionClass NameSendStringInModelAsExceptionFieldsNameTypeDescriptionbodyAddStringInGlobalException-Example (as JSON){"body":{"value":"test"}}SendDynamicInModelAsExceptionClass NameSendDynamicInModelAsExceptionFieldsNameTypeDescriptionbodyAddDynamicInException-Example (as JSON){"body":{"value":" {\r\n\t\t\t\"value\" : \"test\"\r\n\t\t}"}}SendDateInModelAsExceptionClass NameSendDateInModelAsExceptionFieldsNameTypeDescriptionbodyAddDateInGlobalException-Example (as JSON){"body":{"value":"1994-02-13"}}SendUnixTimeStampInModelAsExceptionClass NameSendUnixTimeStampInModelAsExceptionFieldsNameTypeDescriptionbodyAddUnixTimeStampInGlobalException-Example (as JSON){"body":{"dateTime":1484719381}}SendRfc3339InModelAsExceptionClass NameSendRfc3339InModelAsExceptionFieldsNameTypeDescriptionbodyAddRfc3339DatetimeInGlobalException-Example (as JSON){"body":{"dateTime":"2016-03-13T12:52:32.123Z","dateTime1":null}}SendRfc1123InModelAsExceptionClass NameSendRfc1123InModelAsExceptionFieldsNameTypeDescriptionbodyAddRfc1123DatetimeInGlobalException-Example (as JSON){"body":{"dateTime":"Sun, 06 Nov 1994 08:49:37 GMT"}}SendBooleanInModelAsExceptionClass NameSendBooleanInModelAsExceptionFieldsNameTypeDescriptionbodyAddBooleanInGlobalException-Example (as JSON){"body":{"value":false,"value1":null}}ComplexObjectInExceptionClass NameComplexObjectInExceptionFieldsNameTypeDescriptionbodyComplex3-Example (as JSON){"body":{"documentId":"099cceda-38a8-4b01-87b9-a8f2007675d6","signers":[{"id":"1bef97d1-0704-4eb2-a490-a8f2007675db","url":"https://sign-test.idfy.io/start?jwt=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzM4NCJ9.eyJrdmVyc2lvbiI6IjdmNzhjNzNkMmQ1MjQzZWRiYjdiNDI0MmI2MDE1MWU4IiwiZG9jaWQiOiIwOTljY2VkYS0zOGE4LTRiMDEtODdiOS1hOGYyMDA3Njc1ZDYiLCJhaWQiOiJjMGNlMTQ2OC1hYzk0LTRiMzQtODc2ZS1hODg1MDBjMmI5YTEiLCJsZyI6ImVuIiwiZXJyIjpudWxsLCJpZnIiOmZhbHNlLCJ3Ym1zZyI6ZmFsc2UsInNmaWQiOiIxYmVmOTdkMS0wNzA0LTRlYjItYTQ5MC1hOGYyMDA3Njc1ZGIiLCJ1cmxleHAiOm51bGwsImF0aCI6bnVsbCwiZHQiOiJUZXN0IGRvY3VtZW50IiwidmYiOmZhbHNlLCJhbiI6IklkZnkgU0RLIGRlbW8iLCJ0aCI6IlBpbmsiLCJzcCI6IkN1YmVzIiwiZG9tIjpudWxsLCJyZGlyIjpmYWxzZSwidXQiOiJ3ZWIiLCJ1dHYiOm51bGwsInNtIjoidGVzdEB0ZXN0LmNvbSJ9.Dyy2RSeR6dmU8qxOEi-2gEX3Gg7wry6JhkZIWOuADDdu5jJWidQLcxfJn_qAHNpb","links":[],"externalSignerId":"uoiahsd321982983jhrmnec2wsadm32","redirectSettings":{"redirectMode":"donot_redirect"},"signatureType":{"mechanism":"pkisignature","onEacceptUseHandWrittenSignature":false},"ui":{"dialogs":{"before":{"useCheckBox":false,"title":"Info","message":"Please read the contract on the next pages carefully. Pay some extra attention to paragraph 5."}},"language":"EN","styling":{"colorTheme":"Pink","spinner":"Cubes"}},"tags":[],"order":0,"required":false}],"status":{"documentStatus":"unsigned","completedPackages":[],"attachmentPackages":{}},"title":"Test document","description":"This is an important document","externalId":"ae7b9ca7-3839-4e0d-a070-9f14bffbbf55","dataToSign":{"fileName":"sample.txt","convertToPDF":false},"contactDetails":{"email":"test@test.com","url":"https://idfy.io"},"advanced":{"tags":["develop","fun_with_documents"],"attachments":0,"requiredSignatures":0,"getSocialSecurityNumber":false,"timeToLive":{"deadline":"2018-06-29T14:57:25Z","deleteAfterHours":1}}}}EnumInExceptionClass NameEnumInExceptionFieldsNameTypeDescriptionparamParamFormat-mtypeType-Example (as JSON){"param":"Template","type":"Long"}