sfgboxapi

<back to all web services

UsersIntendedAdd

The following routes are available for this service:
POST/users_intended
UsersIntendedAdd Parameters:
NameParameterData TypeRequiredDescription
FirstNamebodystringNo
LastNamebodystringNo
IdentificationNumberbodystringNo
PhoneNumberbodystringNo
LatitudebodydoubleNo
LongitudebodydoubleNo
UsersDetailsIdbodylong?No
UsersIntendedAddResponse Parameters:
NameParameterData TypeRequiredDescription
FirstNameformstringNo
LastNameformstringNo
IdentificationNumberformstringNo
PhoneNumberformstringNo
LatitudeformdoubleNo
LongitudeformdoubleNo
UsersDetailsIdformlong?No
ResponseStatusformResponseStatusNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /users_intended HTTP/1.1 
Host: sfgboxapi.dev.scadsoftware.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"firstName":"String","lastName":"String","identificationNumber":"String","phoneNumber":"String","latitude":0,"longitude":0,"usersDetailsId":0}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"firstName":"String","lastName":"String","identificationNumber":"String","phoneNumber":"String","latitude":0,"longitude":0,"usersDetailsId":0,"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}