Bombshell Agency Platform Service

<back to all web services

PeraAgentRequest

The following routes are available for this service:
PUT,OPTIONS/v1/PeraAgent
GET,OPTIONS/v1/PeraAgent/{CompanyId}/{AgentId}

To override the Content-type in your clients 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.

POST /jsv/reply/PeraAgentRequest HTTP/1.1 
Host: testapi3.teamifg.com 
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 0,
	AgentId: 0,
	Agent: 
	[
		{
			AgentId: 0,
			UserId: 00000000000000000000000000000000,
			FirstName: String,
			LastName: String,
			FullName: String,
			CalendarId: 00000000000000000000000000000000,
			GoogleCalendar: String,
			PeraICSUrl: String,
			AsapOptOut: False,
			AsapLockOut: False,
			AcceptAllAppts: False,
			TimeZone: String,
			Email: String,
			AsapWeeklyAppts: 0,
			SaturdayAppts: False,
			SundayAppts: False,
			AgentLevel: 0,
			Districts: 
			[
				{
					Id: 0,
					AgentId: 0,
					DistrictId: 0,
					Name: String,
					CampaignTypeId: 0
				}
			]
		}
	]
}
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
			}
		]
	},
	Agent: 
	[
		{
			AgentId: 0,
			Company: String,
			AgentName: String,
			FirstName: String,
			LastName: String,
			MiddleInitial: String,
			Address1: String,
			Address2: String,
			City: String,
			State: String,
			Zip: String,
			Country: String,
			Email: String,
			EmailSignature: String,
			HomePhone: String,
			CellPhone: String,
			WorkPhone: String,
			InsLicensed: False,
			AgreeToDisclosures: False,
			AgreeToDate: 0001-01-01,
			PaidDate: 0001-01-01,
			AgentNumber: String,
			ReferringAgent: String,
			PlacementAgent: String,
			CreatedDate: 0001-01-01,
			UserId: 00000000000000000000000000000000,
			IsAgent: False,
			Package: String,
			StoreName: String,
			Notes: String,
			Upline1: 0,
			Upline2: 0,
			Upline3: 0,
			Upline4: 0,
			MVPID: 0,
			AVPID: 0,
			RVPID: 0,
			AgentLevel: 0,
			IsMVP: False,
			IsRVP: False,
			IsAVP: False,
			IsAdmin: False,
			IsBusinessCardAdmin: False,
			TeamName: String,
			CalendarId: 00000000000000000000000000000000,
			Rank: String,
			NBC: False,
			Upline1Percent: 0,
			Upline2Percent: 0,
			Upline3Percent: 0,
			Upline4Percent: 0,
			AgentStatus: String,
			Office: String,
			DOB: 0001-01-01,
			SSN: String,
			Fax: String,
			BusinessEmail: String,
			ModifiedDate: 0001-01-01,
			ModifiedBy: String,
			TimeZone: String,
			LeaderLocked: False,
			LastSubmittedBusinessDate: 0001-01-01,
			GracePeriodDate: 0001-01-01,
			Vested: False,
			DirectPay: 0001-01-01,
			DirectPayApprBy: String,
			FactFinderBilling: 0,
			iDecideUserId: 0,
			AgentTypeId: 0,
			AgentType: String,
			IsLeadership: False,
			EBShares: 0,
			ABShares: 0,
			DirectPayPercentage: 0,
			InactiveAgentBalanceForward: 0,
			TeleSalesBonusOptionId: 0,
			FullName: String,
			ByLastName: String
		}
	]
}