User Create

Description

This call allows you to create a new user account in the OGF system.

URI

REST URI [GET]:
/v11.02/User.svc/Create?SessionId={sessionId}&EmailAddress={email}&Password={password}&FirstName={firstName}&LastName={lastName}&ProductId={product_ID}&Gender={Male|Female}&IndiOgfn={indiOgfn}&PhoneNumber={phoneNumber}&ShippingStreet1={street}&ShippingCity={city}&ShippingStateProvince={state}&ShippingCountry={country}&ShippingPostalCode{zip}&CreditCardName={name+on+card}&CreditCardNumber={number}&CreditCardExpiration={YYYYMM}

Content-Type: Application/xml

Example

Request GET

https://wsdev.onegreatfamily.com/v11.02/User.svc/Create?SessionId=gl4q23cwofpshi55sg1dvc3o&EmailAddress=joe@myemail.com&Password=password&FirstName=First+NameRes&LastName=SurnameRes&ProductId=getProductId

Success Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>0</Code>
	<Message>Success</Message>
	<Value i:type="a:unsignedLong">1855450</Value>
</Result>

Failed Response Payload

<Result xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<Code>27004</Code>
	<Message>The paid user already exists.</Message>
</Result>

Fault Response Payload

<RestFault xmlns="http://schemas.datacontract.org/2004/07/OGF.WS.Data">
	<ErrorCode>551</ErrorCode>
	<FaultMessage>An unhandled exception has occurred</FaultMessage>
</RestFault>

Query String Parameters

Name	Description	Required
SessionId	The current session Id Type: string Default: None	Yes
EmailAddress	The users email address, this will become their username also Type: UInt64 Constraints: Should be a valid email address	Yes
Password	The password the user will use to login Type: String Constraints: Must be less than 20 characters	Yes
FirstName	The users first name Type: String Constraints: Must be less than 20 characters	Yes
LastName	The users last name Type: String Constraints: Must be less than 30 characters	Yes
ProductId	The product Id Type: String Constraints: Must be given and created by us contact us at wsdev@onegreatfamily.com	Yes
Gender	The users gender Type: String Constraints: Must be Male or Female	No
IndiOgfn	This is the Ogfn of the Indi record that represents this user Type: UInt64 Constraints: Must be a valid number for a valid indi	No
PhoneNumber	The users phone number Type: String Constraints: Must be less than 25 characters not including dashes or spaces.	No
`ShippingStreet1`	Street Address First Part Type: String Constraints: Must be less than 25 characters	No
`ShippingStreet2`	Street Address Second Part Type: String Constraints: Must be less than 25 characters	No
`ShippingCity`	The City Name Type: String Constraints: Must be less than 40 characters	No
`ShippingStateProvince`	The State or Province Type: String Constraints: Must be less than 20 characters	No
`ShippingCountry`	The Country Type: String Constraints: Must be less than 30 characters	No
`ShippingPostalCode`	The Postalcode/Zipcode Type: String Constraints: Must be less than 15 characters	No
`CreditCardName`	Name that's on the card Type: String Constraints: Must be less than 50 characters	No
`CreditCardNumber`	Credit card number Type: String Constraints: Consists of a 16 character string [0-9] no spaces or separators	No
`CreditCardExpiration`	The card expiration date Type: String Constraints: short date format of the form MM.YYYY where MM is the Month and YYYY is the year	No

Response Elements

Name	Description
`Result`	This operation returns a Result Entity Type: Result
`Result.Value`	Result.Value will be a UInt64 on success Type: UInt64
`HTTP Status Code`	The Web Server returns a status code which indicates if the operation was successful. Anything other than 200 should be regarded as a failure.
`HTTP Status Code` of 417	The Web Server threw an exception and contains a `RestFault` entity. Retrieve the RestFault from the Webexception response property.