Getting and Updating an Organizer
Organizers can be retrieved and updated via this method. Since the organizer's information is provided by the X-PayItSquare-Token header, there is no need for the id to be specified in the URL.
Method Info
Url | https://www.payit2.com/api/v1/organizer/current |
---|---|
Verb | GET, PUT/POST |
Headers | X-PayItSquare-AppKey, X-PayItSquare-Token |
Input
Property | Data Type | Validation Info |
---|---|---|
FirstName | String | Required, 50 characters max. |
LastName | String | Required, 50 characters max. |
OrganizationName | String | 100 characters max. |
EmailAddress | String | Required |
HidePayPalUpgradeNotification | Boolean | |
CanDelete | Boolean | |
TimeZoneId | String | Valid Time Zone Ids are available at http://msdn.microsoft.com/en-us/library/bb384272.aspx |
Output
Property | Data Type | Other Info |
---|---|---|
IsSuccess | Boolean | Indicates if the call was successful or not. |
Messages | String Array | Will contain a list of error messages if IsSuccess is false |
Sample Get Output
{ "FirstName": "John", "LastName": "Doe", "OrganizationName": "My Organization", "EmailAddress": "myaddress@myemail.com", "HidePayPalUpgradeNotification": false, "CanDelete": false, "TimeZoneId": "UTC" }
Sample Input
{ "FirstName": "John", "LastName": "Doe", "OrganizationName": "My Organization", "EmailAddress": "myaddress@myemail.com", "HidePayPalUpgradeNotification": false, "CanDelete": false, "TimeZoneId": "UTC" }
Sample Success Response
{ "IsSuccess": true, "Messages": [] }
Sample Error Response
{ "IsSuccess": false, "Messages": [ "Error message 1", "Error message 2" ] }