ApexERPHost

<back to all web services

GetBranchPersons

Requires Authentication
The following routes are available for this service:
GET/Crm/company/Branch/Persons/
GetBranchPersons Parameters:
NameParameterData TypeRequiredDescription
Idqueryint?No
BranchIdqueryint?No
PersonIdqueryint?No
WithPersonDataqueryboolNo
GetBranchPersonsResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ResultformList<BranchPerson>No
BranchPerson Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
BranchIdformintNo
PersonformCrmPersonsNo
CrmPersons Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
PersonSNformstringNo
PNameformstringNo
FirstNameformstringNo
LastNameformstringNo
SecondNameformstringNo
DateBornformDateTime?No
PhoneformstringNo
MobileformstringNo
WorkPhoneformstringNo
EmailformstringNo
CityIdformstringNo
DescriptionformstringNo
NoteformstringNo
Citizenshipformint?No
Is_RezidentformboolNo
Sexformint?No
SpendformboolNo
UnidformGuidNo
PhonesformList<pPhone>No
EMailsformList<pEmail>No
WebPagesformList<pWebPage>No
PositionformstringNo
pPhone Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UnidformGuid?No
PhoneTypeformintNo
PhoneformstringNo
PriorityformboolNo
NoteformstringNo
pEmail Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UnidformGuid?No
EmailTypeformintNo
EmailformstringNo
NoteformstringNo
pWebPage Parameters:
NameParameterData TypeRequiredDescription
IdformintNo
UnidformGuid?No
WebPageTypeformintNo
WebPageformstringNo
NoteformstringNo

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

HTTP + JSV

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

GET /Crm/company/Branch/Persons/ HTTP/1.1 
Host: apex.nikoratrade.ge 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Result: 
	[
		{
			Id: 0,
			BranchId: 0,
			Person: 
			{
				Id: 0,
				PersonSN: String,
				PName: String,
				FirstName: String,
				LastName: String,
				SecondName: String,
				DateBorn: 0001-01-01,
				Phone: String,
				Mobile: String,
				WorkPhone: String,
				Email: String,
				CityId: String,
				Description: String,
				Note: String,
				Citizenship: 0,
				Is_Rezident: False,
				Sex: 0,
				Spend: False,
				Unid: 00000000000000000000000000000000,
				Phones: 
				[
					{
						Id: 0,
						Unid: 00000000000000000000000000000000,
						PhoneType: 0,
						Phone: String,
						Priority: False,
						Note: String
					}
				],
				EMails: 
				[
					{
						Id: 0,
						Unid: 00000000000000000000000000000000,
						EmailType: 0,
						Email: String,
						Note: String
					}
				],
				WebPages: 
				[
					{
						Id: 0,
						Unid: 00000000000000000000000000000000,
						WebPageType: 0,
						WebPage: String,
						Note: String
					}
				],
				Position: String
			}
		}
	]
}